VehiclePosition Struct Reference

Realtime positioning information for a given vehicle. More...

Public Types
enum	VehicleStopStatus { INCOMING_AT = 0, STOPPED_AT = 1, IN_TRANSIT_TO = 2 }
enum	CongestionLevel {   UNKNOWN_CONGESTION_LEVEL = 0, RUNNING_SMOOTHLY = 1, STOP_AND_GO = 2, CONGESTION = 3,   SEVERE_CONGESTION = 4 }
	Congestion level that is affecting this vehicle. More...
enum	OccupancyStatus {   EMPTY = 0, MANY_SEATS_AVAILABLE = 1, FEW_SEATS_AVAILABLE = 2, STANDING_ROOM_ONLY = 3,   CRUSHED_STANDING_ROOM_ONLY = 4, FULL = 5, NOT_ACCEPTING_PASSENGERS = 6 }
	The degree of passenger occupancy of the vehicle. More...

Public Attributes
optional TripDescriptor	trip = 1
	The Trip that this vehicle is serving. More...
optional VehicleDescriptor	vehicle = 8
	Additional information on the vehicle that is serving this trip.
optional Position	position = 2
	Current position of this vehicle.
optional uint32	current_stop_sequence = 3
	The stop sequence index of the current stop. More...
optional string	stop_id = 7
	Identifies the current stop. More...
optional VehicleStopStatus	current_status = 4 [default = IN_TRANSIT_TO]
	The exact status of the vehicle with respect to the current stop. More...
optional uint64	timestamp = 5
	Moment at which the vehicle's position was measured. More...
optional CongestionLevel	congestion_level = 6
optional OccupancyStatus	occupancy_status = 9
extensions	to
	The extensions namespace allows 3rd-party developers to extend the GTFS-realtime specification in order to add and evaluate new features and modifications to the spec. More...

Detailed Description

Realtime positioning information for a given vehicle.

Member Enumeration Documentation

enum VehiclePosition::CongestionLevel

Congestion level that is affecting this vehicle.

Enumerator
SEVERE_CONGESTION	People leaving their cars.

enum VehiclePosition::OccupancyStatus

The degree of passenger occupancy of the vehicle.

This field is still experimental, and subject to change. It may be formally adopted in the future.

Enumerator
EMPTY	The vehicle is considered empty by most measures, and has few or no passengers onboard, but is still accepting passengers.
MANY_SEATS_AVAILABLE	The vehicle has a relatively large percentage of seats available. What percentage of free seats out of the total seats available is to be considered large enough to fall into this category is determined at the discretion of the producer.
FEW_SEATS_AVAILABLE	The vehicle has a relatively small percentage of seats available. What percentage of free seats out of the total seats available is to be considered small enough to fall into this category is determined at the discretion of the feed producer.
STANDING_ROOM_ONLY	The vehicle can currently accommodate only standing passengers.
CRUSHED_STANDING_ROOM_ONLY	The vehicle can currently accommodate only standing passengers and has limited space for them.
FULL	The vehicle is considered full by most measures, but may still be allowing passengers to board.
NOT_ACCEPTING_PASSENGERS	The vehicle is not accepting additional passengers.

enum VehiclePosition::VehicleStopStatus

Enumerator
INCOMING_AT	The vehicle is just about to arrive at the stop (on a stop display, the vehicle symbol typically flashes).
STOPPED_AT	The vehicle is standing at the stop.
IN_TRANSIT_TO	The vehicle has departed and is in transit to the next stop.

Member Data Documentation

optional VehicleStopStatus VehiclePosition::current_status = 4 [default = IN_TRANSIT_TO]

The exact status of the vehicle with respect to the current stop.

Ignored if current_stop_sequence is missing.

optional uint32 VehiclePosition::current_stop_sequence = 3

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.

optional string VehiclePosition::stop_id = 7

Identifies the current stop.

The value must be the same as in stops.txt in the corresponding GTFS feed.

optional uint64 VehiclePosition::timestamp = 5

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).

extensions VehiclePosition::to

The extensions namespace allows 3rd-party developers to extend the GTFS-realtime specification in order to add and evaluate new features and modifications to the spec.

optional TripDescriptor VehiclePosition::trip = 1

The Trip that this vehicle is serving.

Can be empty or partial if the vehicle can not be identified with a given trip instance.

---

The documentation for this struct was generated from the following file:

• gtfs-realtime.proto