Created
September 26, 2022 00:55
-
-
Save justinmmott/3985db710d8469ce8ffdfcac6d3c5d20 to your computer and use it in GitHub Desktop.
types for the mta subway GTFS Realtime
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Copyright 2015 The GTFS Specifications Authors. | |
// | |
// Licensed under the Apache License, Version 2.0 (the "License"); | |
// you may not use this file except in compliance with the License. | |
// You may obtain a copy of the License at | |
// | |
// <http://www.apache.org/licenses/LICENSE-2.0> | |
// | |
// Unless required by applicable law or agreed to in writing, software | |
// distributed under the License is distributed on an "AS IS" BASIS, | |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
// See the License for the specific language governing permissions and | |
// limitations under the License. | |
// Protocol definition file for GTFS Realtime. | |
// | |
// GTFS Realtime lets transit agencies provide consumers with realtime | |
// information about disruptions to their service (stations closed, lines not | |
// operating, important delays etc), location of their vehicles and expected | |
// arrival times. | |
// | |
// This protocol is published at: | |
// <https://github.com/google/transit/tree/master/gtfs-realtime> | |
/// The contents of a feed message. | |
/// A feed is a continuous stream of feed messages. Each message in the stream is | |
/// obtained as a response to an appropriate HTTP GET request. | |
/// A realtime feed is always defined with relation to an existing GTFS feed. | |
/// All the entity ids are resolved with respect to the GTFS feed. | |
/// Note that "required" and "optional" as stated in this file refer to Protocol | |
/// Buffer cardinality, not semantic cardinality. See reference.md at | |
/// <https://github.com/google/transit/tree/master/gtfs-realtime> for field | |
/// semantic cardinality. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct FeedMessage { | |
/// Metadata about this feed and feed message. | |
#[prost(message, required, tag="1")] | |
pub header: FeedHeader, | |
/// Contents of the feed. | |
#[prost(message, repeated, tag="2")] | |
pub entity: ::prost::alloc::vec::Vec<FeedEntity>, | |
} | |
/// Metadata about a feed, included in feed messages. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct FeedHeader { | |
/// Version of the feed specification. | |
/// The current version is 2.0. | |
#[prost(string, required, tag="1")] | |
pub gtfs_realtime_version: ::prost::alloc::string::String, | |
#[prost(enumeration="feed_header::Incrementality", optional, tag="2", default="FullDataset")] | |
pub incrementality: ::core::option::Option<i32>, | |
/// This timestamp identifies the moment when the content of this feed has been | |
/// created (in server time). In POSIX time (i.e., number of seconds since | |
/// January 1st 1970 00:00:00 UTC). | |
#[prost(uint64, optional, tag="3")] | |
pub timestamp: ::core::option::Option<u64>, | |
} | |
/// Nested message and enum types in `FeedHeader`. | |
pub mod feed_header { | |
/// 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. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum Incrementality { | |
FullDataset = 0, | |
Differential = 1, | |
} | |
impl Incrementality { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
Incrementality::FullDataset => "FULL_DATASET", | |
Incrementality::Differential => "DIFFERENTIAL", | |
} | |
} | |
} | |
} | |
/// A definition (or update) of an entity in the transit feed. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct FeedEntity { | |
/// The ids are used only to provide incrementality support. The id should be | |
/// unique within a FeedMessage. Consequent FeedMessages may contain | |
/// FeedEntities with the same id. In case of a DIFFERENTIAL update the new | |
/// FeedEntity with some id will replace the old FeedEntity with the same id | |
/// (or delete it - see is_deleted below). | |
/// The actual GTFS entities (e.g. stations, routes, trips) referenced by the | |
/// feed must be specified by explicit selectors (see EntitySelector below for | |
/// more info). | |
#[prost(string, required, tag="1")] | |
pub id: ::prost::alloc::string::String, | |
/// Whether this entity is to be deleted. Relevant only for incremental | |
/// fetches. | |
#[prost(bool, optional, tag="2", default="false")] | |
pub is_deleted: ::core::option::Option<bool>, | |
/// Data about the entity itself. Exactly one of the following fields must be | |
/// present (unless the entity is being deleted). | |
#[prost(message, optional, tag="3")] | |
pub trip_update: ::core::option::Option<TripUpdate>, | |
#[prost(message, optional, tag="4")] | |
pub vehicle: ::core::option::Option<VehiclePosition>, | |
#[prost(message, optional, tag="5")] | |
pub alert: ::core::option::Option<Alert>, | |
} | |
// | |
// Entities used in the feed. | |
// | |
/// Realtime update of the progress of a vehicle along a trip. | |
/// Depending on the value of ScheduleRelationship, a TripUpdate can specify: | |
/// - A trip that proceeds along the schedule. | |
/// - A trip that proceeds along a route but has no fixed schedule. | |
/// - A trip that have been added or removed with regard to schedule. | |
/// | |
/// The updates can be for future, predicted arrival/departure events, or for | |
/// past events that already occurred. | |
/// Normally, updates should get more precise and more certain (see | |
/// uncertainty below) as the events gets closer to current time. | |
/// Even if that is not possible, the information for past events should be | |
/// precise and certain. In particular, if an update points to time in the past | |
/// but its update's uncertainty is not 0, the client should conclude that the | |
/// update is a (wrong) prediction and that the trip has not completed yet. | |
/// | |
/// Note that the update can describe a trip that is already completed. | |
/// To this end, it is enough to provide an update for the last stop of the trip. | |
/// If the time of that is in the past, the client will conclude from that that | |
/// the whole trip is in the past (it is possible, although inconsequential, to | |
/// also provide updates for preceding stops). | |
/// This option is most relevant for a trip that has completed ahead of schedule, | |
/// but according to the schedule, the trip is still proceeding at the current | |
/// time. Removing the updates for this trip could make the client assume | |
/// that the trip is still proceeding. | |
/// Note that the feed provider is allowed, but not required, to purge past | |
/// updates - this is one case where this would be practically useful. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct TripUpdate { | |
/// The Trip that this message applies to. There can be at most one | |
/// TripUpdate entity for each actual trip instance. | |
/// If there is none, that means there is no prediction information available. | |
/// It does *not* mean that the trip is progressing according to schedule. | |
#[prost(message, required, tag="1")] | |
pub trip: TripDescriptor, | |
/// Additional information on the vehicle that is serving this trip. | |
#[prost(message, optional, tag="3")] | |
pub vehicle: ::core::option::Option<VehicleDescriptor>, | |
/// Updates to StopTimes for the trip (both future, i.e., predictions, and in | |
/// some cases, past ones, i.e., those that already happened). | |
/// The updates must be sorted by stop_sequence, and apply for all the | |
/// following stops of the trip up to the next specified one. | |
/// | |
/// Example 1: | |
/// For a trip with 20 stops, a StopTimeUpdate with arrival delay and departure | |
/// delay of 0 for stop_sequence of the current stop means that the trip is | |
/// exactly on time. | |
/// | |
/// Example 2: | |
/// For the same trip instance, 3 StopTimeUpdates are provided: | |
/// - delay of 5 min for stop_sequence 3 | |
/// - delay of 1 min for stop_sequence 8 | |
/// - delay of unspecified duration for stop_sequence 10 | |
/// This will be interpreted as: | |
/// - stop_sequences 3,4,5,6,7 have delay of 5 min. | |
/// - stop_sequences 8,9 have delay of 1 min. | |
/// - stop_sequences 10,... have unknown delay. | |
#[prost(message, repeated, tag="2")] | |
pub stop_time_update: ::prost::alloc::vec::Vec<trip_update::StopTimeUpdate>, | |
/// Moment at which the vehicle's real-time progress was measured. In POSIX | |
/// time (i.e., the number of seconds since January 1st 1970 00:00:00 UTC). | |
#[prost(uint64, optional, tag="4")] | |
pub timestamp: ::core::option::Option<u64>, | |
/// The current schedule deviation for the trip. Delay should only be | |
/// specified when the prediction is given relative to some existing schedule | |
/// in GTFS. | |
/// | |
/// Delay (in seconds) can be positive (meaning that the vehicle is late) or | |
/// negative (meaning that the vehicle is ahead of schedule). Delay of 0 | |
/// means that the vehicle is exactly on time. | |
/// | |
/// Delay information in StopTimeUpdates take precedent of trip-level delay | |
/// information, such that trip-level delay is only propagated until the next | |
/// stop along the trip with a StopTimeUpdate delay value specified. | |
/// | |
/// Feed providers are strongly encouraged to provide a TripUpdate.timestamp | |
/// value indicating when the delay value was last updated, in order to | |
/// evaluate the freshness of the data. | |
/// | |
/// NOTE: This field is still experimental, and subject to change. It may be | |
/// formally adopted in the future. | |
#[prost(int32, optional, tag="5")] | |
pub delay: ::core::option::Option<i32>, | |
} | |
/// Nested message and enum types in `TripUpdate`. | |
pub mod trip_update { | |
/// Timing information for a single predicted event (either arrival or | |
/// departure). | |
/// Timing consists of delay and/or estimated time, and uncertainty. | |
/// - delay should be used when the prediction is given relative to some | |
/// existing schedule in GTFS. | |
/// - time should be given whether there is a predicted schedule or not. If | |
/// both time and delay are specified, time will take precedence | |
/// (although normally, time, if given for a scheduled trip, should be | |
/// equal to scheduled time in GTFS + delay). | |
/// | |
/// Uncertainty applies equally to both time and delay. | |
/// The uncertainty roughly specifies the expected error in true delay (but | |
/// note, we don't yet define its precise statistical meaning). It's possible | |
/// for the uncertainty to be 0, for example for trains that are driven under | |
/// computer timing control. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct StopTimeEvent { | |
/// Delay (in seconds) can be positive (meaning that the vehicle is late) or | |
/// negative (meaning that the vehicle is ahead of schedule). Delay of 0 | |
/// means that the vehicle is exactly on time. | |
#[prost(int32, optional, tag="1")] | |
pub delay: ::core::option::Option<i32>, | |
/// Event as absolute time. | |
/// In Unix time (i.e., number of seconds since January 1st 1970 00:00:00 | |
/// UTC). | |
#[prost(int64, optional, tag="2")] | |
pub time: ::core::option::Option<i64>, | |
/// If uncertainty is omitted, it is interpreted as unknown. | |
/// If the prediction is unknown or too uncertain, the delay (or time) field | |
/// should be empty. In such case, the uncertainty field is ignored. | |
/// To specify a completely certain prediction, set its uncertainty to 0. | |
#[prost(int32, optional, tag="3")] | |
pub uncertainty: ::core::option::Option<i32>, | |
} | |
/// 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. | |
/// | |
/// The update is linked to a specific stop either through stop_sequence or | |
/// stop_id, so one of the fields below must necessarily be set. | |
/// See the documentation in TripDescriptor for more information. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct StopTimeUpdate { | |
/// Must be the same as in stop_times.txt in the corresponding GTFS feed. | |
#[prost(uint32, optional, tag="1")] | |
pub stop_sequence: ::core::option::Option<u32>, | |
/// Must be the same as in stops.txt in the corresponding GTFS feed. | |
#[prost(string, optional, tag="4")] | |
pub stop_id: ::core::option::Option<::prost::alloc::string::String>, | |
#[prost(message, optional, tag="2")] | |
pub arrival: ::core::option::Option<StopTimeEvent>, | |
#[prost(message, optional, tag="3")] | |
pub departure: ::core::option::Option<StopTimeEvent>, | |
#[prost(enumeration="stop_time_update::ScheduleRelationship", optional, tag="5", default="Scheduled")] | |
pub schedule_relationship: ::core::option::Option<i32>, | |
} | |
/// Nested message and enum types in `StopTimeUpdate`. | |
pub mod stop_time_update { | |
/// The relation between this StopTime and the static schedule. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum ScheduleRelationship { | |
/// The vehicle is proceeding in accordance with its static schedule of | |
/// stops, although not necessarily according to the times of the schedule. | |
/// At least one of arrival and departure must be provided. If the schedule | |
/// for this stop contains both arrival and departure times then so must | |
/// this update. | |
Scheduled = 0, | |
/// The stop is skipped, i.e., the vehicle will not stop at this stop. | |
/// Arrival and departure are optional. | |
Skipped = 1, | |
/// No data is given for this stop. The main intention for this value is to | |
/// give the predictions only for part of a trip, i.e., if the last update | |
/// for a trip has a NO_DATA specifier, then StopTimes for the rest of the | |
/// stops in the trip are considered to be unspecified as well. | |
/// Neither arrival nor departure should be supplied. | |
NoData = 2, | |
} | |
impl ScheduleRelationship { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
ScheduleRelationship::Scheduled => "SCHEDULED", | |
ScheduleRelationship::Skipped => "SKIPPED", | |
ScheduleRelationship::NoData => "NO_DATA", | |
} | |
} | |
} | |
} | |
} | |
/// Realtime positioning information for a given vehicle. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct VehiclePosition { | |
/// The Trip that this vehicle is serving. | |
/// Can be empty or partial if the vehicle can not be identified with a given | |
/// trip instance. | |
#[prost(message, optional, tag="1")] | |
pub trip: ::core::option::Option<TripDescriptor>, | |
/// Additional information on the vehicle that is serving this trip. | |
#[prost(message, optional, tag="8")] | |
pub vehicle: ::core::option::Option<VehicleDescriptor>, | |
/// Current position of this vehicle. | |
#[prost(message, optional, tag="2")] | |
pub position: ::core::option::Option<Position>, | |
/// 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. | |
#[prost(uint32, optional, tag="3")] | |
pub current_stop_sequence: ::core::option::Option<u32>, | |
/// Identifies the current stop. The value must be the same as in stops.txt in | |
/// the corresponding GTFS feed. | |
#[prost(string, optional, tag="7")] | |
pub stop_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// The exact status of the vehicle with respect to the current stop. | |
/// Ignored if current_stop_sequence is missing. | |
#[prost(enumeration="vehicle_position::VehicleStopStatus", optional, tag="4", default="InTransitTo")] | |
pub current_status: ::core::option::Option<i32>, | |
/// 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). | |
#[prost(uint64, optional, tag="5")] | |
pub timestamp: ::core::option::Option<u64>, | |
#[prost(enumeration="vehicle_position::CongestionLevel", optional, tag="6")] | |
pub congestion_level: ::core::option::Option<i32>, | |
#[prost(enumeration="vehicle_position::OccupancyStatus", optional, tag="9")] | |
pub occupancy_status: ::core::option::Option<i32>, | |
} | |
/// Nested message and enum types in `VehiclePosition`. | |
pub mod vehicle_position { | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum VehicleStopStatus { | |
/// The vehicle is just about to arrive at the stop (on a stop | |
/// display, the vehicle symbol typically flashes). | |
IncomingAt = 0, | |
/// The vehicle is standing at the stop. | |
StoppedAt = 1, | |
/// The vehicle has departed and is in transit to the next stop. | |
InTransitTo = 2, | |
} | |
impl VehicleStopStatus { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
VehicleStopStatus::IncomingAt => "INCOMING_AT", | |
VehicleStopStatus::StoppedAt => "STOPPED_AT", | |
VehicleStopStatus::InTransitTo => "IN_TRANSIT_TO", | |
} | |
} | |
} | |
/// Congestion level that is affecting this vehicle. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum CongestionLevel { | |
UnknownCongestionLevel = 0, | |
RunningSmoothly = 1, | |
StopAndGo = 2, | |
Congestion = 3, | |
/// People leaving their cars. | |
SevereCongestion = 4, | |
} | |
impl CongestionLevel { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
CongestionLevel::UnknownCongestionLevel => "UNKNOWN_CONGESTION_LEVEL", | |
CongestionLevel::RunningSmoothly => "RUNNING_SMOOTHLY", | |
CongestionLevel::StopAndGo => "STOP_AND_GO", | |
CongestionLevel::Congestion => "CONGESTION", | |
CongestionLevel::SevereCongestion => "SEVERE_CONGESTION", | |
} | |
} | |
} | |
/// 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. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum OccupancyStatus { | |
/// The vehicle is considered empty by most measures, and has few or no | |
/// passengers onboard, but is still accepting passengers. | |
Empty = 0, | |
/// 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. | |
ManySeatsAvailable = 1, | |
/// 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. | |
FewSeatsAvailable = 2, | |
/// The vehicle can currently accommodate only standing passengers. | |
StandingRoomOnly = 3, | |
/// The vehicle can currently accommodate only standing passengers | |
/// and has limited space for them. | |
CrushedStandingRoomOnly = 4, | |
/// The vehicle is considered full by most measures, but may still be | |
/// allowing passengers to board. | |
Full = 5, | |
/// The vehicle is not accepting additional passengers. | |
NotAcceptingPassengers = 6, | |
} | |
impl OccupancyStatus { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
OccupancyStatus::Empty => "EMPTY", | |
OccupancyStatus::ManySeatsAvailable => "MANY_SEATS_AVAILABLE", | |
OccupancyStatus::FewSeatsAvailable => "FEW_SEATS_AVAILABLE", | |
OccupancyStatus::StandingRoomOnly => "STANDING_ROOM_ONLY", | |
OccupancyStatus::CrushedStandingRoomOnly => "CRUSHED_STANDING_ROOM_ONLY", | |
OccupancyStatus::Full => "FULL", | |
OccupancyStatus::NotAcceptingPassengers => "NOT_ACCEPTING_PASSENGERS", | |
} | |
} | |
} | |
} | |
/// An alert, indicating some sort of incident in the public transit network. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct Alert { | |
/// Time when the alert should be shown to the user. If missing, the | |
/// alert will be shown as long as it appears in the feed. | |
/// If multiple ranges are given, the alert will be shown during all of them. | |
#[prost(message, repeated, tag="1")] | |
pub active_period: ::prost::alloc::vec::Vec<TimeRange>, | |
/// Entities whose users we should notify of this alert. | |
#[prost(message, repeated, tag="5")] | |
pub informed_entity: ::prost::alloc::vec::Vec<EntitySelector>, | |
#[prost(enumeration="alert::Cause", optional, tag="6", default="UnknownCause")] | |
pub cause: ::core::option::Option<i32>, | |
#[prost(enumeration="alert::Effect", optional, tag="7", default="UnknownEffect")] | |
pub effect: ::core::option::Option<i32>, | |
/// The URL which provides additional information about the alert. | |
#[prost(message, optional, tag="8")] | |
pub url: ::core::option::Option<TranslatedString>, | |
/// Alert header. Contains a short summary of the alert text as plain-text. | |
#[prost(message, optional, tag="10")] | |
pub header_text: ::core::option::Option<TranslatedString>, | |
/// Full description for the alert as plain-text. The information in the | |
/// description should add to the information of the header. | |
#[prost(message, optional, tag="11")] | |
pub description_text: ::core::option::Option<TranslatedString>, | |
} | |
/// Nested message and enum types in `Alert`. | |
pub mod alert { | |
/// Cause of this alert. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum Cause { | |
UnknownCause = 1, | |
/// Not machine-representable. | |
OtherCause = 2, | |
TechnicalProblem = 3, | |
/// Public transit agency employees stopped working. | |
Strike = 4, | |
/// People are blocking the streets. | |
Demonstration = 5, | |
Accident = 6, | |
Holiday = 7, | |
Weather = 8, | |
Maintenance = 9, | |
Construction = 10, | |
PoliceActivity = 11, | |
MedicalEmergency = 12, | |
} | |
impl Cause { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
Cause::UnknownCause => "UNKNOWN_CAUSE", | |
Cause::OtherCause => "OTHER_CAUSE", | |
Cause::TechnicalProblem => "TECHNICAL_PROBLEM", | |
Cause::Strike => "STRIKE", | |
Cause::Demonstration => "DEMONSTRATION", | |
Cause::Accident => "ACCIDENT", | |
Cause::Holiday => "HOLIDAY", | |
Cause::Weather => "WEATHER", | |
Cause::Maintenance => "MAINTENANCE", | |
Cause::Construction => "CONSTRUCTION", | |
Cause::PoliceActivity => "POLICE_ACTIVITY", | |
Cause::MedicalEmergency => "MEDICAL_EMERGENCY", | |
} | |
} | |
} | |
/// What is the effect of this problem on the affected entity. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum Effect { | |
NoService = 1, | |
ReducedService = 2, | |
/// We don't care about INsignificant delays: they are hard to detect, have | |
/// little impact on the user, and would clutter the results as they are too | |
/// frequent. | |
SignificantDelays = 3, | |
Detour = 4, | |
AdditionalService = 5, | |
ModifiedService = 6, | |
OtherEffect = 7, | |
UnknownEffect = 8, | |
StopMoved = 9, | |
} | |
impl Effect { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
Effect::NoService => "NO_SERVICE", | |
Effect::ReducedService => "REDUCED_SERVICE", | |
Effect::SignificantDelays => "SIGNIFICANT_DELAYS", | |
Effect::Detour => "DETOUR", | |
Effect::AdditionalService => "ADDITIONAL_SERVICE", | |
Effect::ModifiedService => "MODIFIED_SERVICE", | |
Effect::OtherEffect => "OTHER_EFFECT", | |
Effect::UnknownEffect => "UNKNOWN_EFFECT", | |
Effect::StopMoved => "STOP_MOVED", | |
} | |
} | |
} | |
} | |
// | |
// Low level data structures used above. | |
// | |
/// 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. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct TimeRange { | |
/// Start time, in POSIX time (i.e., number of seconds since January 1st 1970 | |
/// 00:00:00 UTC). | |
/// If missing, the interval starts at minus infinity. | |
#[prost(uint64, optional, tag="1")] | |
pub start: ::core::option::Option<u64>, | |
/// End time, in POSIX time (i.e., number of seconds since January 1st 1970 | |
/// 00:00:00 UTC). | |
/// If missing, the interval ends at plus infinity. | |
#[prost(uint64, optional, tag="2")] | |
pub end: ::core::option::Option<u64>, | |
} | |
/// A position. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct Position { | |
/// Degrees North, in the WGS-84 coordinate system. | |
#[prost(float, required, tag="1")] | |
pub latitude: f32, | |
/// Degrees East, in the WGS-84 coordinate system. | |
#[prost(float, required, tag="2")] | |
pub longitude: f32, | |
/// Bearing, in degrees, clockwise from North, i.e., 0 is North and 90 is East. | |
/// This can be the compass bearing, or the direction towards the next stop | |
/// or intermediate location. | |
/// This should not be direction deduced from the sequence of previous | |
/// positions, which can be computed from previous data. | |
#[prost(float, optional, tag="3")] | |
pub bearing: ::core::option::Option<f32>, | |
/// Odometer value, in meters. | |
#[prost(double, optional, tag="4")] | |
pub odometer: ::core::option::Option<f64>, | |
/// Momentary speed measured by the vehicle, in meters per second. | |
#[prost(float, optional, tag="5")] | |
pub speed: ::core::option::Option<f32>, | |
} | |
/// A descriptor that identifies an instance of a GTFS trip, or all instances of | |
/// a trip along a route. | |
/// - To specify a single trip instance, the trip_id (and if necessary, | |
/// start_time) is set. If route_id is also set, then it should be same as one | |
/// that the given trip corresponds to. | |
/// - To specify all the trips along a given route, only the route_id should be | |
/// set. Note that if the trip_id is not known, then stop sequence ids in | |
/// TripUpdate are not sufficient, and stop_ids must be provided as well. In | |
/// addition, absolute arrival/departure times must be provided. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct TripDescriptor { | |
/// The trip_id from the GTFS feed that this selector refers to. | |
/// For non frequency-based trips, this field is enough to uniquely identify | |
/// the trip. For frequency-based trip, start_time and start_date might also be | |
/// necessary. | |
#[prost(string, optional, tag="1")] | |
pub trip_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// The route_id from the GTFS that this selector refers to. | |
#[prost(string, optional, tag="5")] | |
pub route_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// The direction_id from the GTFS feed trips.txt file, indicating the | |
/// direction of travel for trips this selector refers to. This field is | |
/// still experimental, and subject to change. It may be formally adopted in | |
/// the future. | |
#[prost(uint32, optional, tag="6")] | |
pub direction_id: ::core::option::Option<u32>, | |
/// The initially scheduled start time of this trip instance. | |
/// When the trip_id corresponds to a non-frequency-based trip, this field | |
/// should either be omitted or be equal to the value in the GTFS feed. When | |
/// the trip_id corresponds to a frequency-based trip, the start_time must be | |
/// specified for trip updates and vehicle positions. If the trip corresponds | |
/// to exact_times=1 GTFS record, then start_time must be some multiple | |
/// (including zero) of headway_secs later than frequencies.txt start_time for | |
/// the corresponding time period. If the trip corresponds to exact_times=0, | |
/// then its start_time may be arbitrary, and is initially expected to be the | |
/// first departure of the trip. Once established, the start_time of this | |
/// frequency-based trip should be considered immutable, even if the first | |
/// departure time changes -- that time change may instead be reflected in a | |
/// StopTimeUpdate. | |
/// Format and semantics of the field is same as that of | |
/// GTFS/frequencies.txt/start_time, e.g., 11:15:35 or 25:15:35. | |
#[prost(string, optional, tag="2")] | |
pub start_time: ::core::option::Option<::prost::alloc::string::String>, | |
/// The scheduled start date of this trip instance. | |
/// Must be provided to disambiguate trips that are so late as to collide with | |
/// a scheduled trip on a next day. For example, for a train that departs 8:00 | |
/// and 20:00 every day, and is 12 hours late, there would be two distinct | |
/// trips on the same time. | |
/// This field can be provided but is not mandatory for schedules in which such | |
/// collisions are impossible - for example, a service running on hourly | |
/// schedule where a vehicle that is one hour late is not considered to be | |
/// related to schedule anymore. | |
/// In YYYYMMDD format. | |
#[prost(string, optional, tag="3")] | |
pub start_date: ::core::option::Option<::prost::alloc::string::String>, | |
#[prost(enumeration="trip_descriptor::ScheduleRelationship", optional, tag="4")] | |
pub schedule_relationship: ::core::option::Option<i32>, | |
} | |
/// Nested message and enum types in `TripDescriptor`. | |
pub mod trip_descriptor { | |
/// 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. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum ScheduleRelationship { | |
/// Trip that is running in accordance with its GTFS schedule, or is close | |
/// enough to the scheduled trip to be associated with it. | |
Scheduled = 0, | |
/// An extra trip that was added in addition to a running schedule, for | |
/// example, to replace a broken vehicle or to respond to sudden passenger | |
/// load. | |
Added = 1, | |
/// A trip that is running with no schedule associated to it, for example, if | |
/// there is no schedule at all. | |
Unscheduled = 2, | |
/// A trip that existed in the schedule but was removed. | |
Canceled = 3, | |
} | |
impl ScheduleRelationship { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
ScheduleRelationship::Scheduled => "SCHEDULED", | |
ScheduleRelationship::Added => "ADDED", | |
ScheduleRelationship::Unscheduled => "UNSCHEDULED", | |
ScheduleRelationship::Canceled => "CANCELED", | |
} | |
} | |
} | |
} | |
/// Identification information for the vehicle performing the trip. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct VehicleDescriptor { | |
/// Internal system identification of the vehicle. Should be unique per | |
/// vehicle, and can be used for tracking the vehicle as it proceeds through | |
/// the system. | |
#[prost(string, optional, tag="1")] | |
pub id: ::core::option::Option<::prost::alloc::string::String>, | |
/// User visible label, i.e., something that must be shown to the passenger to | |
/// help identify the correct vehicle. | |
#[prost(string, optional, tag="2")] | |
pub label: ::core::option::Option<::prost::alloc::string::String>, | |
/// The license plate of the vehicle. | |
#[prost(string, optional, tag="3")] | |
pub license_plate: ::core::option::Option<::prost::alloc::string::String>, | |
} | |
/// A selector for an entity in a GTFS feed. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct EntitySelector { | |
/// 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. | |
#[prost(string, optional, tag="1")] | |
pub agency_id: ::core::option::Option<::prost::alloc::string::String>, | |
#[prost(string, optional, tag="2")] | |
pub route_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// corresponds to route_type in GTFS. | |
#[prost(int32, optional, tag="3")] | |
pub route_type: ::core::option::Option<i32>, | |
#[prost(message, optional, tag="4")] | |
pub trip: ::core::option::Option<TripDescriptor>, | |
#[prost(string, optional, tag="5")] | |
pub stop_id: ::core::option::Option<::prost::alloc::string::String>, | |
} | |
/// 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: | |
/// 1. If the UI language matches the language code of a translation, | |
/// the first matching translation is picked. | |
/// 2. If a default UI language (e.g., English) matches the language code of a | |
/// translation, the first matching translation is picked. | |
/// 3. If some translation has an unspecified language code, that translation is | |
/// picked. | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct TranslatedString { | |
/// At least one translation must be provided. | |
#[prost(message, repeated, tag="1")] | |
pub translation: ::prost::alloc::vec::Vec<translated_string::Translation>, | |
} | |
/// Nested message and enum types in `TranslatedString`. | |
pub mod translated_string { | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct Translation { | |
/// A UTF-8 string containing the message. | |
#[prost(string, required, tag="1")] | |
pub text: ::prost::alloc::string::String, | |
/// BCP-47 language code. Can be omitted if the language is unknown or if | |
/// no i18n is done at all for the feed. At most one translation is | |
/// allowed to have an unspecified language tag. | |
#[prost(string, optional, tag="2")] | |
pub language: ::core::option::Option<::prost::alloc::string::String>, | |
} | |
} | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct TripReplacementPeriod { | |
/// The replacement period is for this route | |
#[prost(string, optional, tag="1")] | |
pub route_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// The start time is omitted, the end time is currently now + 30 minutes for | |
/// all routes of the A division | |
#[prost(message, optional, tag="2")] | |
pub replacement_period: ::core::option::Option<TimeRange>, | |
} | |
/// NYCT Subway extensions for the feed header | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct NyctFeedHeader { | |
/// Version of the NYCT Subway extensions | |
/// The current version is 1.0 | |
#[prost(string, required, tag="1")] | |
pub nyct_subway_version: ::prost::alloc::string::String, | |
/// For the NYCT Subway, the GTFS-realtime feed replaces any scheduled | |
/// trip within the trip_replacement_period. | |
/// This feed is a full dataset, it contains all trips starting | |
/// in the trip_replacement_period. If a trip from the static GTFS is not | |
/// found in the GTFS-realtime feed, it should be considered as cancelled. | |
/// The replacement period can be different for each route, so here is | |
/// a list of the routes where the trips in the feed replace all | |
/// scheduled trips within the replacement period. | |
#[prost(message, repeated, tag="2")] | |
pub trip_replacement_period: ::prost::alloc::vec::Vec<TripReplacementPeriod>, | |
} | |
/// NYCT Subway extensions for the trip descriptor | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct NyctTripDescriptor { | |
/// The nyct_train_id is meant for internal use only. It provides an | |
/// easy way to associated GTFS-realtime trip identifiers with NYCT rail | |
/// operations identifier | |
/// | |
/// The ATS office system assigns unique train identification (Train ID) to | |
/// each train operating within or ready to enter the mainline of the | |
/// monitored territory. An example of this is 06 0123+ PEL/BBR and is decoded | |
/// as follows: | |
/// | |
/// The first character represents the trip type designator. 0 identifies a | |
/// scheduled revenue trip. Other revenue trip values that are a result of a | |
/// change to the base schedule include; [= reroute], [/ skip stop], [$ turn | |
/// train] also known as shortly lined service. | |
/// | |
/// The second character 6 represents the trip line i.e. number 6 train The | |
/// third set of characters identify the decoded origin time. The last | |
/// character may be blank "on the whole minute" or + "30 seconds" | |
/// | |
/// Note: Origin times will not change when there is a trip type change. This | |
/// is followed by a three character "Origin Location" / "Destination | |
/// Location" | |
#[prost(string, optional, tag="1")] | |
pub train_id: ::core::option::Option<::prost::alloc::string::String>, | |
/// This trip has been assigned to a physical train. If true, this trip is | |
/// already underway or most likely will depart shortly. | |
/// | |
/// Train Assignment is a function of the Automatic Train Supervision (ATS) | |
/// office system used by NYCT Rail Operations to monitor and track train | |
/// movements. ATS provides the ability to "assign" the nyct_train_id | |
/// attribute when a physical train is at its origin terminal. These assigned | |
/// trips have the is_assigned field set in the TripDescriptor. | |
/// | |
/// When a train is at a terminal but has not been given a work program it is | |
/// declared unassigned and is tagged as such. Unassigned trains can be moved | |
/// to a storage location or assigned a nyct_train_id when a determination for | |
/// service is made. | |
#[prost(bool, optional, tag="2")] | |
pub is_assigned: ::core::option::Option<bool>, | |
/// Uptown and Bronx-bound trains are moving NORTH. | |
/// Times Square Shuttle to Grand Central is also northbound. | |
/// | |
/// Downtown and Brooklyn-bound trains are moving SOUTH. | |
/// Times Square Shuttle to Times Square is also southbound. | |
/// | |
/// EAST and WEST are not used currently. | |
#[prost(enumeration="nyct_trip_descriptor::Direction", optional, tag="3")] | |
pub direction: ::core::option::Option<i32>, | |
} | |
/// Nested message and enum types in `NyctTripDescriptor`. | |
pub mod nyct_trip_descriptor { | |
/// The direction the train is moving. | |
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] | |
#[repr(i32)] | |
pub enum Direction { | |
North = 1, | |
East = 2, | |
South = 3, | |
West = 4, | |
} | |
impl Direction { | |
/// String value of the enum field names used in the ProtoBuf definition. | |
/// | |
/// The values are not transformed in any way and thus are considered stable | |
/// (if the ProtoBuf definition does not change) and safe for programmatic use. | |
pub fn as_str_name(&self) -> &'static str { | |
match self { | |
Direction::North => "NORTH", | |
Direction::East => "EAST", | |
Direction::South => "SOUTH", | |
Direction::West => "WEST", | |
} | |
} | |
} | |
} | |
/// NYCT Subway extensions for the stop time update | |
#[derive(Clone, PartialEq, ::prost::Message)] | |
pub struct NyctStopTimeUpdate { | |
/// Provides the planned station arrival track. The following is the Manhattan | |
/// track configurations: | |
/// 1: southbound local | |
/// 2: southbound express | |
/// 3: northbound express | |
/// 4: northbound local | |
/// | |
/// In the Bronx (except Dyre Ave line) | |
/// M: bi-directional express (in the AM express to Manhattan, in the PM | |
/// express away). | |
/// | |
/// The Dyre Ave line is configured: | |
/// 1: southbound | |
/// 2: northbound | |
/// 3: bi-directional | |
#[prost(string, optional, tag="1")] | |
pub scheduled_track: ::core::option::Option<::prost::alloc::string::String>, | |
/// This is the actual track that the train is operating on and can be used to | |
/// determine if a train is operating according to its current schedule | |
/// (plan). | |
/// | |
/// The actual track is known only shortly before the train reaches a station, | |
/// typically not before it leaves the previous station. Therefore, the NYCT | |
/// feed sets this field only for the first station of the remaining trip. | |
/// | |
/// Different actual and scheduled track is the result of manually rerouting a | |
/// train off it scheduled path. When this occurs, prediction data may become | |
/// unreliable since the train is no longer operating in accordance to its | |
/// schedule. The rules engine for the 'countdown' clocks will remove this | |
/// train from all schedule stations. | |
#[prost(string, optional, tag="2")] | |
pub actual_track: ::core::option::Option<::prost::alloc::string::String>, | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment