VehiclePosition class

Realtime positioning information for a given vehicle.

Inheritance
  • Object
  • GeneratedMessage
  • VehiclePosition

Constructors

VehiclePosition.new({TripDescriptor? trip, Position? position, int? currentStopSequence, VehiclePosition_VehicleStopStatus? currentStatus, Int64? timestamp, VehiclePosition_CongestionLevel? congestionLevel, String? stopId, VehicleDescriptor? vehicle, VehiclePosition_OccupancyStatus? occupancyStatus, int? occupancyPercentage, Iterable<VehiclePosition_CarriageDetails>? multiCarriageDetails})
factory
VehiclePosition.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
VehiclePosition.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

congestionLevel ↔ VehiclePosition_CongestionLevel
getter/setter pair
currentStatus ↔ VehiclePosition_VehicleStopStatus
The exact status of the vehicle with respect to the current stop. Ignored if current_stop_sequence is missing.
getter/setter pair
currentStopSequence ↔ int
The stop sequence index of the current stop. The meaning of current_stop_sequence (i.e., the stop that it refers to) is determined by current_status. If current_status is missing IN_TRANSIT_TO is assumed.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
multiCarriageDetails → List<VehiclePosition_CarriageDetails>
Details of the multiple carriages of this given vehicle. The first occurrence represents the first carriage of the vehicle, given the current direction of travel. The number of occurrences of the multi_carriage_details field represents the number of carriages of the vehicle. It also includes non boardable carriages, like engines, maintenance carriages, etc… as they provide valuable information to passengers about where to stand on a platform. This message/field is still experimental, and subject to change. It may be formally adopted in the future.
no setter
occupancyPercentage ↔ int
A percentage value indicating the degree of passenger occupancy in the vehicle. The values are represented as an integer without decimals. 0 means 0% and 100 means 100%. The value 100 should represent the total maximum occupancy the vehicle was designed for, including both seated and standing capacity, and current operating regulations allow. The value may exceed 100 if there are more passengers than the maximum designed capacity. The precision of occupancy_percentage should be low enough that individual passengers cannot be tracked boarding or alighting the vehicle. If multi_carriage_status is populated with per-carriage occupancy_percentage, then this field should describe the entire vehicle with all carriages accepting passengers considered. This field is still experimental, and subject to change. It may be formally adopted in the future.
getter/setter pair
occupancyStatus ↔ VehiclePosition_OccupancyStatus
If multi_carriage_status is populated with per-carriage OccupancyStatus, then this field should describe the entire vehicle with all carriages accepting passengers considered.
getter/setter pair
position ↔ Position
Current position of this vehicle.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stopId ↔ String
Identifies the current stop. The value must be the same as in stops.txt in the corresponding GTFS feed.
getter/setter pair
timestamp ↔ Int64
Moment at which the vehicle's position was measured. In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC).
getter/setter pair
trip ↔ TripDescriptor
The Trip that this vehicle is serving. Can be empty or partial if the vehicle can not be identified with a given trip instance.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vehicle ↔ VehicleDescriptor
Additional information on the vehicle that is serving this trip.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearCongestionLevel() → void
clearCurrentStatus() → void
clearCurrentStopSequence() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearOccupancyPercentage() → void
clearOccupancyStatus() → void
clearPosition() → void
clearStopId() → void
clearTimestamp() → void
clearTrip() → void
clearVehicle() → void
clone() → VehiclePosition
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(VehiclePosition)) → VehiclePosition
Apply updates to a copy of this message.
override
createEmptyInstance() → VehiclePosition
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensurePosition() → Position
ensureTrip() → TripDescriptor
ensureVehicle() → VehicleDescriptor
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasCongestionLevel() → bool
hasCurrentStatus() → bool
hasCurrentStopSequence() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasOccupancyPercentage() → bool
hasOccupancyStatus() → bool
hasPosition() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasStopId() → bool
hasTimestamp() → bool
hasTrip() → bool
hasVehicle() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited