Module gtfs

Module gtfs 

Source
Expand description

GTFS Readers

Structs§

GTFSAgency
Agency Information
GTFSArea
Areas
GTFSAttribution
Attributions
GTFSBookingRule
Booking Rules
GTFSCalendar
Calendar Information
GTFSCalendarDate
Calendar Dates
GTFSFareAttribute
Fare Attributes (GTFS-Fares V1)
GTFSFareLegJoinRule
Fare Leg Join Rules
GTFSFareLegRule
Fare Leg Rules
GTFSFareMedia
Fare Media
GTFSFareProduct
Fare Products
GTFSFareRule
Fare Rules
GTFSFareTransferRule
Fare Transfer Rules
GTFSFeedInfo
Feed Information
GTFSFrequency
Frequency
GTFSLevel
Levels
GTFSLocationGroup
Location Groups
GTFSLocationGroupStop
Location Group Stops
GTFSLocationsProperties
locations.geojson data properties Defines zones where riders can request either pickup or drop off by on-demand services. These zones are represented as GeoJSON polygons.
GTFSNetwork
Networks
GTFSPathway
Pathways
GTFSRealtimeAlert
An alert, indicating some sort of incident in the public transit network.
GTFSRealtimeEntity
A definition (or update) of an entity in the transit feed. May be a TripUpdate, VehiclePosition, Alert, Shape, Stop, and/or TripModifications. At least one of the above must be present (unless the entity is being deleted).
GTFSRealtimeEntitySelector
A selector for an entity in a GTFS feed. The values of the fields should correspond to the appropriate fields in the GTFS feed. At least one specifier must be given. If several are given, then the matching has to apply to all the given specifiers.
GTFSRealtimeHeader
Metadata about a feed, included in feed messages.
GTFSRealtimeModification
A Modification message replaces a span of n stop times from each affected trip starting at start_stop_selector.
GTFSRealtimeModifiedTripSelector
A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
GTFSRealtimeMultiCarriageDetails
Carriage specific details, used for vehicles composed of several carriages This message/field is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimePosition
A Position is a point on the Earth’s surface.
GTFSRealtimeReader
GTFS Realtime message.
GTFSRealtimeReplacementStop
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimeSelectedTrips
Selected trips affected by TripModifications.
GTFSRealtimeShape
Describes the physical path that a vehicle takes when it’s not part of the (CSV) GTFS, such as for a detour. Shapes belong to Trips, and consist of a sequence of shape points. Tracing the points in order provides the path of the vehicle. Shapes do not need to intercept the location of Stops exactly, but all Stops on a trip should lie within a small distance of the shape for that trip, i.e. close to straight line segments connecting the shape points NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future
GTFSRealtimeStop
Describes a stop which is served by trips. All fields are as described in the GTFS-Static specification. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimeStopSelector
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future. Select a stop by stop sequence or by stop_id. At least one of the two values must be provided.
GTFSRealtimeStopTimeEvent
Timing information for a single predicted event (either arrival or departure).
GTFSRealtimeStopTimeProperties
Provides the updated values for the stop time. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimeStopTimeUpdate
Realtime update for arrival and/or departure events for a given stop on a trip. Updates can be supplied for both past and future events. The producer is allowed, although not required, to drop past events.
GTFSRealtimeTimeRange
A time interval. The interval is considered active at time ‘t’ if ‘t’ is greater than or equal to the start time and less than the end time.
GTFSRealtimeTranslatedString
An internationalized message containing per-language versions of a snippet of text or a URL. One of the strings from a message will be picked up. The resolution proceeds as follows:
GTFSRealtimeTranslation
The translations field of a GTFSRealtimeTranslatedString
GTFSRealtimeTripDescriptor
A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
GTFSRealtimeTripModifications
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimeTripProperties
Defines updated properties of the trip, such as a new shape_id when there is a detour. Or defines the trip_id, start_date, and start_time of a DUPLICATED trip. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future
GTFSRealtimeTripUpdate
Realtime update of the progress of a vehicle along a trip. Depending on the value of ScheduleRelationship, a TripUpdate can specify:
GTFSRealtimeVehicleDescriptor
Identification information for the vehicle performing the trip.
GTFSRealtimeVehiclePosition
Realtime positioning information for a given vehicle.
GTFSRoute
Route Information
GTFSRouteNetwork
Route Networks
GTFSScheduleIterator
The GTFS Schedule Iterator tool
GTFSScheduleReader
GTFS Schedule Reader
GTFSShape
Shapes
GTFSShapeMValue
Shape MValue
GTFSShapeProperties
Shape Properties
GTFSShapes
Shapes
GTFSStop
Stop Information
GTFSStopArea
Stop Areas
GTFSStopProperties
Properties object from GTFS stops
GTFSStopTime
Stop Time Information
GTFSTimeframe
Timeframes
GTFSTransfer
Transfers
GTFSTranslation
Translations
GTFSTrip
Trip Information
Piece
A piece of the GTFS schedule

Enums§

GTFSBikesAllowed
Indicates whether bikes are allowed. Valid options are:
GTFSBookingType
Describes how far in advance rider can book: 0 - Real-time 1 - Same-day (with advance notice) 2 - Prior day(s)
GTFSContinuousPickupDropOff
Continuous pickup behavior from this stop_time to the next.
GTFSDayAvailability
Enumeration to represent day availability in the calendar. 0 = Not available, 1 = Available
GTFSDirectionId
Indicates the direction of travel for a trip. This field should not be used in routing; it provides a way to separate trips by direction when publishing time tables. Valid options are:
GTFSDurationLimitType
Duration limit type for how transfer durations are measured. Required if duration_limit is defined, forbidden otherwise.
GTFSExactTimes
Indicates the type of service for a trip with frequencies: 0 or empty = Frequency-based trips 1 = Schedule-based trips (with identical headway)
GTFSExceptionType
Describes whether service is added or removed on a specific date. 1 - Service added for this date. 2 - Service removed for this date.
GTFSFareMediaType
Describes the type of fare media used. 0 - None 1 - Physical paper ticket 2 - Physical transit card 3 - cEMV (contactless) 4 - Mobile app
GTFSFareTransferType
Fare transfer type describing how costs are processed between consecutive legs:
GTFSIncrementality
Determines whether the current fetch is incremental. Currently, DIFFERENTIAL mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized.
GTFSIsBidirectional
Indicates whether a pathway can be used in both directions:
GTFSPathwayMode
Describes the type of pathway between two stops or station nodes.
GTFSPaymentMethod
Indicates when the fare must be paid:
GTFSPickupDropOffType
Pickup method.
GTFSRealtimeCause
Cause of this alert. If cause_detail is included, then Cause must also be included.
GTFSRealtimeCongestionLevel
Congestion level that is affecting this vehicle.
GTFSRealtimeEffect
What is the effect of this problem on the affected entity. If effect_detail is included, then Effect must also be included.
GTFSRealtimeEntityMessage
The type of a GTFSRealtimeEntity message
GTFSRealtimeOccupancyStatus
The state of passenger occupancy for the vehicle or carriage. Individual producers may not publish all OccupancyStatus values. Therefore, consumers must not assume that the OccupancyStatus values follow a linear scale. Consumers should represent OccupancyStatus values as the state indicated and intended by the producer. Likewise, producers must use OccupancyStatus values that correspond to actual vehicle occupancy states. For describing passenger occupancy levels on a linear scale, see occupancy_percentage. This field is still experimental, and subject to change. It may be formally adopted in the future.
GTFSRealtimeScheduleRelationship
The relation between this trip and the static schedule. If a trip is done in accordance with temporary schedule, not reflected in GTFS, then it shouldn’t be marked as SCHEDULED, but likely as ADDED.
GTFSRealtimeScheduleRelationshipUpdate
The relation between the StopTimeEvents and the static schedule.
GTFSRealtimeSeverityLevel
Severity of this alert.
GTFSRealtimeWheelchairAccessible
Wheelchair accessibility of the trip
GTFSRealtimeWheelchairBoarding
The type of wheelchair boarding accessibility at a stop.
GTFSRoutePickupType
Continuous pickup setting for the entire route. 0 - Continuous stopping pickup, 1/empty - No continuous stopping pickup, 2 - Must phone agency, 3 - Must coordinate with driver.
GTFSRouteType
Indicates the type of transportation used on a route. Valid options include: 0 - Tram 1 - Subway 2 - Rail 3 - Bus 4 - Ferry, 5 - Cable tram 6 - Aerial lift 7 - Funicular, 11 - Trolleybus 12 - Monorail.
GTFSStopLocationType
Location type. Valid options:
GTFSTimepoint
Indicates if arrival/departure times are exact or approximate.
GTFSTransferType
TransferType enumerates how a rider can transfer between routes/trips/stops:
GTFSTransfersType
Transfers can be:
GTFSVehicleStopStatus
Status of the vehicle relative to the stop
GTFSWheelchairAccessibility
Indicates wheelchair accessibility. Valid options are:

Functions§

parse_gtfs_date
Convenience method to parse a GTFS date (YYYYMMDD) into a JavaScript Date. Because GTFS dates do not contain timezone info, this function treats them as local dates.