Google Maps FleetEngine V1 Client - Class VehicleLocation (0.1.2)

Reference documentation and code samples for the Google Maps FleetEngine V1 Client class VehicleLocation.

The location, speed, and heading of a vehicle at a point in time.

Generated from protobuf message maps.fleetengine.v1.VehicleLocation

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ location Google\Type\LatLng

The location of the vehicle. When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

↳ horizontal_accuracy Google\Protobuf\DoubleValue

Deprecated: Use latlng_accuracy instead.

↳ latlng_accuracy Google\Protobuf\DoubleValue

Accuracy of location in meters as a radius.

↳ heading Google\Protobuf\Int32Value

Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

↳ bearing_accuracy Google\Protobuf\DoubleValue

Deprecated: Use heading_accuracy instead.

↳ heading_accuracy Google\Protobuf\DoubleValue

Accuracy of heading in degrees.

↳ altitude Google\Protobuf\DoubleValue

Altitude in meters above WGS84.

↳ vertical_accuracy Google\Protobuf\DoubleValue

Deprecated: Use altitude_accuracy instead.

↳ altitude_accuracy Google\Protobuf\DoubleValue

Accuracy of altitude in meters.

↳ speed_kmph Google\Protobuf\Int32Value

Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

↳ speed Google\Protobuf\DoubleValue

Speed of the vehicle in meters/second

↳ speed_accuracy Google\Protobuf\DoubleValue

Accuracy of speed in meters/second.

↳ update_time Google\Protobuf\Timestamp

The time when location was reported by the sensor according to the sensor's clock.

↳ server_time Google\Protobuf\Timestamp

Output only. The time when the server received the location information.

↳ location_sensor int

Provider of location data (for example, GPS).

↳ is_road_snapped Google\Protobuf\BoolValue

Whether location is snapped to a road.

↳ is_gps_sensor_enabled Google\Protobuf\BoolValue

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

↳ time_since_update Google\Protobuf\Int32Value

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

↳ num_stale_updates Google\Protobuf\Int32Value

Input only. Deprecated: Other signals are now used to determine if a location is stale.

↳ raw_location Google\Type\LatLng

Raw vehicle location (unprocessed by road-snapper).

↳ raw_location_time Google\Protobuf\Timestamp

Timestamp associated with the raw location.

↳ raw_location_sensor int

Source of the raw location. Defaults to GPS.

↳ raw_location_accuracy Google\Protobuf\DoubleValue

Accuracy of raw_location as a radius, in meters.

↳ supplemental_location Google\Type\LatLng

Supplemental location provided by the integrating app.

↳ supplemental_location_time Google\Protobuf\Timestamp

Timestamp associated with the supplemental location.

↳ supplemental_location_sensor int

Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

↳ supplemental_location_accuracy Google\Protobuf\DoubleValue

Accuracy of supplemental_location as a radius, in meters.

↳ road_snapped bool

Deprecated: Use is_road_snapped instead.

getLocation

The location of the vehicle.

When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

Returns
Type Description
Google\Type\LatLng|null

hasLocation

clearLocation

setLocation

The location of the vehicle.

When it is sent to Fleet Engine, the vehicle's location is a GPS location. When you receive it in a response, the vehicle's location can be either a GPS location, a supplemental location, or some other estimated location. The source is specified in location_sensor.

Parameter
Name Description
var Google\Type\LatLng
Returns
Type Description
$this

getHorizontalAccuracy

Deprecated: Use latlng_accuracy instead.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasHorizontalAccuracy

clearHorizontalAccuracy

getHorizontalAccuracyUnwrapped

Returns the unboxed value from getHorizontalAccuracy()

Deprecated: Use latlng_accuracy instead.

Returns
Type Description
float|null

setHorizontalAccuracy

Deprecated: Use latlng_accuracy instead.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setHorizontalAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Deprecated: Use latlng_accuracy instead.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getLatlngAccuracy

Accuracy of location in meters as a radius.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasLatlngAccuracy

clearLatlngAccuracy

getLatlngAccuracyUnwrapped

Returns the unboxed value from getLatlngAccuracy()

Accuracy of location in meters as a radius.

Returns
Type Description
float|null

setLatlngAccuracy

Accuracy of location in meters as a radius.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setLatlngAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of location in meters as a radius.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getHeading

Direction the vehicle is moving in degrees. 0 represents North.

The valid range is [0,360).

Returns
Type Description
Google\Protobuf\Int32Value|null

hasHeading

clearHeading

getHeadingUnwrapped

Returns the unboxed value from getHeading()

Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

Returns
Type Description
int|null

setHeading

Direction the vehicle is moving in degrees. 0 represents North.

The valid range is [0,360).

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setHeadingUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Direction the vehicle is moving in degrees. 0 represents North. The valid range is [0,360).

Parameter
Name Description
var int|null
Returns
Type Description
$this

getBearingAccuracy

Deprecated: Use heading_accuracy instead.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasBearingAccuracy

clearBearingAccuracy

getBearingAccuracyUnwrapped

Returns the unboxed value from getBearingAccuracy()

Deprecated: Use heading_accuracy instead.

Returns
Type Description
float|null

setBearingAccuracy

Deprecated: Use heading_accuracy instead.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setBearingAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Deprecated: Use heading_accuracy instead.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getHeadingAccuracy

Accuracy of heading in degrees.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasHeadingAccuracy

clearHeadingAccuracy

getHeadingAccuracyUnwrapped

Returns the unboxed value from getHeadingAccuracy()

Accuracy of heading in degrees.

Returns
Type Description
float|null

setHeadingAccuracy

Accuracy of heading in degrees.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setHeadingAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of heading in degrees.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getAltitude

Altitude in meters above WGS84.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasAltitude

clearAltitude

getAltitudeUnwrapped

Returns the unboxed value from getAltitude()

Altitude in meters above WGS84.

Returns
Type Description
float|null

setAltitude

Altitude in meters above WGS84.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setAltitudeUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Altitude in meters above WGS84.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getVerticalAccuracy

Deprecated: Use altitude_accuracy instead.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasVerticalAccuracy

clearVerticalAccuracy

getVerticalAccuracyUnwrapped

Returns the unboxed value from getVerticalAccuracy()

Deprecated: Use altitude_accuracy instead.

Returns
Type Description
float|null

setVerticalAccuracy

Deprecated: Use altitude_accuracy instead.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setVerticalAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Deprecated: Use altitude_accuracy instead.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getAltitudeAccuracy

Accuracy of altitude in meters.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasAltitudeAccuracy

clearAltitudeAccuracy

getAltitudeAccuracyUnwrapped

Returns the unboxed value from getAltitudeAccuracy()

Accuracy of altitude in meters.

Returns
Type Description
float|null

setAltitudeAccuracy

Accuracy of altitude in meters.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setAltitudeAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of altitude in meters.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getSpeedKmph

Speed of the vehicle in kilometers per hour.

Deprecated: Use speed instead.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasSpeedKmph

clearSpeedKmph

getSpeedKmphUnwrapped

Returns the unboxed value from getSpeedKmph()

Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

Returns
Type Description
int|null

setSpeedKmph

Speed of the vehicle in kilometers per hour.

Deprecated: Use speed instead.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setSpeedKmphUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Speed of the vehicle in kilometers per hour. Deprecated: Use speed instead.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getSpeed

Speed of the vehicle in meters/second

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasSpeed

clearSpeed

getSpeedUnwrapped

Returns the unboxed value from getSpeed()

Speed of the vehicle in meters/second

Returns
Type Description
float|null

setSpeed

Speed of the vehicle in meters/second

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setSpeedUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Speed of the vehicle in meters/second

Parameter
Name Description
var float|null
Returns
Type Description
$this

getSpeedAccuracy

Accuracy of speed in meters/second.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasSpeedAccuracy

clearSpeedAccuracy

getSpeedAccuracyUnwrapped

Returns the unboxed value from getSpeedAccuracy()

Accuracy of speed in meters/second.

Returns
Type Description
float|null

setSpeedAccuracy

Accuracy of speed in meters/second.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setSpeedAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of speed in meters/second.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getUpdateTime

The time when location was reported by the sensor according to the sensor's clock.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The time when location was reported by the sensor according to the sensor's clock.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getServerTime

Output only. The time when the server received the location information.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasServerTime

clearServerTime

setServerTime

Output only. The time when the server received the location information.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLocationSensor

Provider of location data (for example, GPS).

Returns
Type Description
int

setLocationSensor

Provider of location data (for example, GPS).

Parameter
Name Description
var int
Returns
Type Description
$this

getIsRoadSnapped

Whether location is snapped to a road.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasIsRoadSnapped

clearIsRoadSnapped

getIsRoadSnappedUnwrapped

Returns the unboxed value from getIsRoadSnapped()

Whether location is snapped to a road.

Returns
Type Description
bool|null

setIsRoadSnapped

Whether location is snapped to a road.

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setIsRoadSnappedUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Whether location is snapped to a road.

Parameter
Name Description
var bool|null
Returns
Type Description
$this

getIsGpsSensorEnabled

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasIsGpsSensorEnabled

clearIsGpsSensorEnabled

getIsGpsSensorEnabledUnwrapped

Returns the unboxed value from getIsGpsSensorEnabled()

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Returns
Type Description
bool|null

setIsGpsSensorEnabled

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setIsGpsSensorEnabledUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Input only. Indicates whether the GPS sensor is enabled on the mobile device.

Parameter
Name Description
var bool|null
Returns
Type Description
$this

getTimeSinceUpdate

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasTimeSinceUpdate

clearTimeSinceUpdate

getTimeSinceUpdateUnwrapped

Returns the unboxed value from getTimeSinceUpdate()

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Returns
Type Description
int|null

setTimeSinceUpdate

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setTimeSinceUpdateUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Input only. Time (in seconds) since this location was first sent to the server. This will be zero for the first update. If the time is unknown (for example, when the app restarts), this value resets to zero.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getNumStaleUpdates

Input only. Deprecated: Other signals are now used to determine if a location is stale.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasNumStaleUpdates

clearNumStaleUpdates

getNumStaleUpdatesUnwrapped

Returns the unboxed value from getNumStaleUpdates()

Input only. Deprecated: Other signals are now used to determine if a location is stale.

Returns
Type Description
int|null

setNumStaleUpdates

Input only. Deprecated: Other signals are now used to determine if a location is stale.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setNumStaleUpdatesUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Input only. Deprecated: Other signals are now used to determine if a location is stale.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getRawLocation

Raw vehicle location (unprocessed by road-snapper).

Returns
Type Description
Google\Type\LatLng|null

hasRawLocation

clearRawLocation

setRawLocation

Raw vehicle location (unprocessed by road-snapper).

Parameter
Name Description
var Google\Type\LatLng
Returns
Type Description
$this

getRawLocationTime

Timestamp associated with the raw location.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRawLocationTime

clearRawLocationTime

setRawLocationTime

Timestamp associated with the raw location.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRawLocationSensor

Source of the raw location. Defaults to GPS.

Returns
Type Description
int

setRawLocationSensor

Source of the raw location. Defaults to GPS.

Parameter
Name Description
var int
Returns
Type Description
$this

getRawLocationAccuracy

Accuracy of raw_location as a radius, in meters.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasRawLocationAccuracy

clearRawLocationAccuracy

getRawLocationAccuracyUnwrapped

Returns the unboxed value from getRawLocationAccuracy()

Accuracy of raw_location as a radius, in meters.

Returns
Type Description
float|null

setRawLocationAccuracy

Accuracy of raw_location as a radius, in meters.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setRawLocationAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of raw_location as a radius, in meters.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getSupplementalLocation

Supplemental location provided by the integrating app.

Returns
Type Description
Google\Type\LatLng|null

hasSupplementalLocation

clearSupplementalLocation

setSupplementalLocation

Supplemental location provided by the integrating app.

Parameter
Name Description
var Google\Type\LatLng
Returns
Type Description
$this

getSupplementalLocationTime

Timestamp associated with the supplemental location.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasSupplementalLocationTime

clearSupplementalLocationTime

setSupplementalLocationTime

Timestamp associated with the supplemental location.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSupplementalLocationSensor

Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

Returns
Type Description
int

setSupplementalLocationSensor

Source of the supplemental location. Defaults to CUSTOMER_SUPPLIED_LOCATION.

Parameter
Name Description
var int
Returns
Type Description
$this

getSupplementalLocationAccuracy

Accuracy of supplemental_location as a radius, in meters.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasSupplementalLocationAccuracy

clearSupplementalLocationAccuracy

getSupplementalLocationAccuracyUnwrapped

Returns the unboxed value from getSupplementalLocationAccuracy()

Accuracy of supplemental_location as a radius, in meters.

Returns
Type Description
float|null

setSupplementalLocationAccuracy

Accuracy of supplemental_location as a radius, in meters.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$this

setSupplementalLocationAccuracyUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Accuracy of supplemental_location as a radius, in meters.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getRoadSnapped

Deprecated: Use is_road_snapped instead.

Returns
Type Description
bool

setRoadSnapped

Deprecated: Use is_road_snapped instead.

Parameter
Name Description
var bool
Returns
Type Description
$this