gis-tools-ts - v0.6.0
    Preparing search index...

    Class GTFSRealtimeVehiclePosition

    Realtime positioning information for a given vehicle.

    Index

    Constructors

    Properties

    congestionLevel?: GTFSRealtimeCongestionLevel

    Congestion level that is affecting this vehicle.

    currentStatus: VehicleStopStatus = VehicleStopStatus.IN_TRANSIT_TO

    The exact status of the vehicle with respect to the current stop. Ignored if current_stop_sequence is missing.

    currentStopSequence?: number

    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.

    multiCarriageDetails: GTFSRealtimeMultiCarriageDetails[] = []

    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.

    occupancyPercentage?: number

    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.

    occupancyStatus?: GTFSRealtimeOccupancyStatus

    If multi_carriage_status is populated with per-carriage OccupancyStatus, then this field should describe the entire vehicle with all carriages accepting passengers considered.

    Current position of this vehicle.

    stopId?: string

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

    timestamp?: Date

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

    The Trip that this vehicle is serving. Can be empty or partial if the vehicle can not be identified with a given trip instance.

    Additional information on the vehicle that is serving this trip.