GTFSRealtimeViz.Proto (gtfs_realtime_viz v0.11.0)

Copy Markdown View Source

Dialyzer typedefs of all the GTFS Realtime structs in the .proto file.

Summary

Types

alert()

@type alert() :: %GTFSRealtimeViz.Proto.Alert{
  __uf__: term(),
  active_period: [time_range()],
  cause:
    nil
    | :UNKNOWN_CAUSE
    | :OTHER_CAUSE
    | :TECHNICAL_PROBLEM
    | :STRIKE
    | :DEMONSTRATION
    | :ACCIDENT
    | :HOLIDAY
    | :WEATHER
    | :MAINTENANCE
    | :CONSTRUCTION
    | :POLICE_ACTIVITY
    | :MEDICAL_EMERGENCY,
  description_text: nil | translated_string(),
  effect:
    nil
    | :NO_SERVICE
    | :REDUCED_SERVICE
    | :SIGNIFICANT_DELAYS
    | :DETOUR
    | :ADDITIONAL_SERVICE
    | :OTHER_EFFECT
    | :UNKNOWN_EFFECT
    | :STOP_MOVED,
  header_text: nil | translated_string(),
  informed_entity: [entity_selector()],
  url: nil | translated_string()
}

entity_selector()

@type entity_selector() :: %GTFSRealtimeViz.Proto.EntitySelector{
  __uf__: term(),
  agency_id: nil | String.t(),
  route_id: nil | String.t(),
  route_type: nil | integer(),
  stop_id: nil | String.t(),
  trip: nil | trip_descriptor()
}

feed_entity()

@type feed_entity() :: %GTFSRealtimeViz.Proto.FeedEntity{
  __uf__: term(),
  alert: nil | alert(),
  id: String.t(),
  is_deleted: boolean(),
  trip_update: nil | trip_update(),
  vehicle: nil | vehicle_position()
}

feed_header()

@type feed_header() :: %GTFSRealtimeViz.Proto.FeedHeader{
  __uf__: term(),
  gtfs_realtime_version: String.t(),
  incrementality: nil | :FULL_DATASET | :DIFFERENTIAL,
  timestamp: nil | integer()
}

feed_message()

@type feed_message() :: %GTFSRealtimeViz.Proto.FeedMessage{
  __uf__: term(),
  entity: [feed_entity()],
  header: feed_header()
}

position()

@type position() :: %GTFSRealtimeViz.Proto.Position{
  __uf__: term(),
  bearing: nil | float(),
  latitude: float(),
  longitude: float(),
  odometer: nil | float(),
  speed: nil | float()
}

raw()

@type raw() :: bitstring()

time_range()

@type time_range() :: %GTFSRealtimeViz.Proto.TimeRange{
  __uf__: term(),
  end: nil | integer(),
  start: nil | integer()
}

translated_string()

@type translated_string() :: %GTFSRealtimeViz.Proto.TranslatedString{
  __uf__: term(),
  translation: [translated_string_translation()]
}

translated_string_translation()

@type translated_string_translation() ::
  %GTFSRealtimeViz.Proto.TranslatedString.Translation{
    __uf__: term(),
    language: nil | String.t(),
    text: String.t()
  }

trip_descriptor()

@type trip_descriptor() :: %GTFSRealtimeViz.Proto.TripDescriptor{
  __uf__: term(),
  direction_id: nil | integer(),
  route_id: nil | String.t(),
  schedule_relationship: nil | :SCHEDULED | :ADDED | :UNSCHEDULED | :CANCELED,
  start_date: nil | String.t(),
  start_time: nil | String.t(),
  trip_id: nil | String.t()
}

trip_update()

@type trip_update() :: %GTFSRealtimeViz.Proto.TripUpdate{
  __uf__: term(),
  delay: nil | integer(),
  stop_time_update: [trip_update_stop_time_update()],
  timestamp: nil | integer(),
  trip: trip_descriptor(),
  vehicle: nil | vehicle_descriptor()
}

trip_update_stop_time_event()

@type trip_update_stop_time_event() ::
  %GTFSRealtimeViz.Proto.TripUpdate.StopTimeEvent{
    __uf__: term(),
    delay: nil | integer(),
    time: nil | integer(),
    uncertainty: nil | integer()
  }

trip_update_stop_time_update()

@type trip_update_stop_time_update() ::
  %GTFSRealtimeViz.Proto.TripUpdate.StopTimeUpdate{
    __uf__: term(),
    arrival: nil | trip_update_stop_time_event(),
    departure: nil | trip_update_stop_time_event(),
    schedule_relationship: nil | :SCHEDULED | :SKIPPED | :NO_DATA,
    stop_id: nil | String.t(),
    stop_sequence: nil | integer()
  }

vehicle_descriptor()

@type vehicle_descriptor() :: %GTFSRealtimeViz.Proto.VehicleDescriptor{
  __uf__: term(),
  id: nil | String.t(),
  label: nil | String.t(),
  license_plate: nil | String.t()
}

vehicle_position()

@type vehicle_position() :: %GTFSRealtimeViz.Proto.VehiclePosition{
  __uf__: term(),
  congestion_level:
    nil
    | :UNKNOWN_CONGESTION_LEVEL
    | :RUNNING_SMOOTHLY
    | :STOP_AND_GO
    | :CONGESTION
    | :SEVERE_CONGESTION,
  current_status: nil | vehicle_position_statuses(),
  current_stop_sequence: nil | integer(),
  occupancy_status:
    nil
    | :EMPTY
    | :MANY_SEATS_AVAILABLE
    | :FEW_SEATS_AVAILABLE
    | :STANDING_ROOM_ONLY
    | :CRUSHED_STANDING_ROOM_ONLY
    | :FULL
    | :NOT_ACCEPTING_PASSENGERS,
  position: nil | position(),
  stop_id: nil | String.t(),
  timestamp: nil | integer(),
  trip: nil | trip_descriptor(),
  vehicle: nil | vehicle_descriptor()
}

vehicle_position_statuses()

@type vehicle_position_statuses() :: :INCOMING_AT | :STOPPED_AT | :IN_TRANSIT_TO