Class: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: TripStatus

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(arrival_enabled: , block_trip_sequence: , departure_enabled: , number_of_stops_away: , predicted_arrival_time: , predicted_departure_time: , route_id: , scheduled_arrival_time: , scheduled_departure_time: , service_date: , stop_id: , stop_sequence: , total_stops_in_trip: , trip_headsign: , trip_id: , vehicle_id: , actual_track: nil, distance_from_stop: nil, frequency: nil, historical_occupancy: nil, last_update_time: nil, occupancy_status: nil, predicted: nil, predicted_arrival_interval: nil, predicted_departure_interval: nil, predicted_occupancy: nil, route_long_name: nil, route_short_name: nil, scheduled_arrival_interval: nil, scheduled_departure_interval: nil, scheduled_track: nil, situation_ids: nil, status: nil, trip_status: nil) ⇒ Object

Some parameter documentations has been truncated, see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry for more details.

Parameters:

  • arrival_enabled (Boolean) (defaults to: ) —

    Indicates if riders can arrive on this transit vehicle.

  • block_trip_sequence (Integer) (defaults to: ) —

    Index of this arrival’s trip into the sequence of trips for the active block.

  • departure_enabled (Boolean) (defaults to: ) —

    Indicates if riders can depart from this transit vehicle.

  • number_of_stops_away (Integer) (defaults to: ) —

    Number of stops between the arriving transit vehicle and the current stop (exclu

  • predicted_arrival_time (Integer) (defaults to: ) —

    Predicted arrival time, in milliseconds since Unix epoch (zero if no real-time a

  • predicted_departure_time (Integer) (defaults to: ) —

    Predicted departure time, in milliseconds since Unix epoch (zero if no real-time

  • route_id (String) (defaults to: ) —

    The ID of the route for the arriving vehicle.

  • scheduled_arrival_time (Integer) (defaults to: ) —

    Scheduled arrival time, in milliseconds since Unix epoch.

  • scheduled_departure_time (Integer) (defaults to: ) —

    Scheduled departure time, in milliseconds since Unix epoch.

  • service_date (Integer) (defaults to: ) —

    Time, in milliseconds since the Unix epoch, of midnight for the start of the ser

  • stop_id (String) (defaults to: ) —

    The ID of the stop the vehicle is arriving at.

  • stop_sequence (Integer) (defaults to: ) —

    Index of the stop into the sequence of stops that make up the trip for this arri

  • total_stops_in_trip (Integer) (defaults to: ) —

    Total number of stops visited on the trip for this arrival.

  • trip_headsign (String) (defaults to: ) —

    Optional trip headsign that potentially overrides the trip headsign in the refer

  • trip_id (String) (defaults to: ) —

    The ID of the trip for the arriving vehicle.

  • vehicle_id (String) (defaults to: ) —

    ID of the transit vehicle serving this trip.

  • actual_track (String) (defaults to: nil) —

    The actual track information of the arriving transit vehicle.

  • distance_from_stop (Float) (defaults to: nil) —

    Distance of the arriving transit vehicle from the stop, in meters.

  • frequency (String) (defaults to: nil) —

    Information about frequency-based scheduling, if applicable to the trip.

  • historical_occupancy (String) (defaults to: nil) —

    Historical occupancy information of the transit vehicle.

  • last_update_time (Integer) (defaults to: nil) —

    Timestamp of the last update time for this arrival.

  • occupancy_status (String) (defaults to: nil) —

    Current occupancy status of the transit vehicle.

  • predicted (Boolean) (defaults to: nil) —

    Indicates if real-time arrival info is available for this trip.

  • predicted_arrival_interval (String) (defaults to: nil) —

    Interval for predicted arrival time, if available.

  • predicted_departure_interval (String) (defaults to: nil) —

    Interval for predicted departure time, if available.

  • predicted_occupancy (String) (defaults to: nil) —

    Predicted occupancy status of the transit vehicle.

  • route_long_name (String) (defaults to: nil) —

    Optional route long name that potentially overrides the route long name in the r

  • route_short_name (String) (defaults to: nil) —

    Optional route short name that potentially overrides the route short name in the

  • scheduled_arrival_interval (String) (defaults to: nil) —

    Interval for scheduled arrival time.

  • scheduled_departure_interval (String) (defaults to: nil) —

    Interval for scheduled departure time.

  • scheduled_track (String) (defaults to: nil) —

    Scheduled track information of the arriving transit vehicle.

  • situation_ids (Array<String>) (defaults to: nil) —

    References to situation elements (if any) applicable to this arrival.

  • status (String) (defaults to: nil) —

    Current status of the arrival.

  • trip_status (OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus) (defaults to: nil) —

    Trip-specific status for the arriving transit vehicle.




# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 246

Instance Attribute Details

#actual_track ⇒ String?

The actual track information of the arriving transit vehicle.

Returns:

  • (String, nil) 


138
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 138

optional :actual_track, String, api_name: :actualTrack

#arrival_enabled ⇒ Boolean

Indicates if riders can arrive on this transit vehicle.

Returns:

  • (Boolean) 


36
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 36

required :arrival_enabled, OnebusawaySDK::Internal::Type::Boolean, api_name: :arrivalEnabled

#block_trip_sequence ⇒ Integer

Index of this arrival’s trip into the sequence of trips for the active block.

Returns:

  • (Integer) 


42
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 42

required :block_trip_sequence, Integer, api_name: :blockTripSequence

#departure_enabled ⇒ Boolean

Indicates if riders can depart from this transit vehicle.

Returns:

  • (Boolean) 


48
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 48

required :departure_enabled, OnebusawaySDK::Internal::Type::Boolean, api_name: :departureEnabled

#distance_from_stop ⇒ Float?

Distance of the arriving transit vehicle from the stop, in meters.

Returns:

  • (Float, nil) 


144
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 144

optional :distance_from_stop, Float, api_name: :distanceFromStop

#frequency ⇒ String?

Information about frequency-based scheduling, if applicable to the trip.

Returns:

  • (String, nil) 


150
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 150

optional :frequency, String

#historical_occupancy ⇒ String?

Historical occupancy information of the transit vehicle.

Returns:

  • (String, nil) 


156
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 156

optional :historical_occupancy, String, api_name: :historicalOccupancy

#last_update_time ⇒ Integer?

Timestamp of the last update time for this arrival.

Returns:

  • (Integer, nil) 


162
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 162

optional :last_update_time, Integer, api_name: :lastUpdateTime

#number_of_stops_away ⇒ Integer

Number of stops between the arriving transit vehicle and the current stop (excluding the current stop).

Returns:

  • (Integer) 


55
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 55

required :number_of_stops_away, Integer, api_name: :numberOfStopsAway

#occupancy_status ⇒ String?

Current occupancy status of the transit vehicle.

Returns:

  • (String, nil) 


168
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 168

optional :occupancy_status, String, api_name: :occupancyStatus

#predicted ⇒ Boolean?

Indicates if real-time arrival info is available for this trip.

Returns:

  • (Boolean, nil) 


174
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 174

optional :predicted, OnebusawaySDK::Internal::Type::Boolean

#predicted_arrival_interval ⇒ String?

Interval for predicted arrival time, if available.

Returns:

  • (String, nil) 


180
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 180

optional :predicted_arrival_interval, String, api_name: :predictedArrivalInterval

#predicted_arrival_time ⇒ Integer

Predicted arrival time, in milliseconds since Unix epoch (zero if no real-time available).

Returns:

  • (Integer) 


62
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 62

required :predicted_arrival_time, Integer, api_name: :predictedArrivalTime

#predicted_departure_interval ⇒ String?

Interval for predicted departure time, if available.

Returns:

  • (String, nil) 


186
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 186

optional :predicted_departure_interval, String, api_name: :predictedDepartureInterval

#predicted_departure_time ⇒ Integer

Predicted departure time, in milliseconds since Unix epoch (zero if no real-time available).

Returns:

  • (Integer) 


69
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 69

required :predicted_departure_time, Integer, api_name: :predictedDepartureTime

#predicted_occupancy ⇒ String?

Predicted occupancy status of the transit vehicle.

Returns:

  • (String, nil) 


192
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 192

optional :predicted_occupancy, String, api_name: :predictedOccupancy

#route_id ⇒ String

The ID of the route for the arriving vehicle.

Returns:

  • (String) 


75
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 75

required :route_id, String, api_name: :routeId

#route_long_name ⇒ String?

Optional route long name that potentially overrides the route long name in the referenced route element.

Returns:

  • (String, nil) 


199
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 199

optional :route_long_name, String, api_name: :routeLongName

#route_short_name ⇒ String?

Optional route short name that potentially overrides the route short name in the referenced route element.

Returns:

  • (String, nil) 


206
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 206

optional :route_short_name, String, api_name: :routeShortName

#scheduled_arrival_interval ⇒ String?

Interval for scheduled arrival time.

Returns:

  • (String, nil) 


212
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 212

optional :scheduled_arrival_interval, String, api_name: :scheduledArrivalInterval

#scheduled_arrival_time ⇒ Integer

Scheduled arrival time, in milliseconds since Unix epoch.

Returns:

  • (Integer) 


81
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 81

required :scheduled_arrival_time, Integer, api_name: :scheduledArrivalTime

#scheduled_departure_interval ⇒ String?

Interval for scheduled departure time.

Returns:

  • (String, nil) 


218
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 218

optional :scheduled_departure_interval, String, api_name: :scheduledDepartureInterval

#scheduled_departure_time ⇒ Integer

Scheduled departure time, in milliseconds since Unix epoch.

Returns:

  • (Integer) 


87
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 87

required :scheduled_departure_time, Integer, api_name: :scheduledDepartureTime

#scheduled_track ⇒ String?

Scheduled track information of the arriving transit vehicle.

Returns:

  • (String, nil) 


224
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 224

optional :scheduled_track, String, api_name: :scheduledTrack

#service_date ⇒ Integer

Time, in milliseconds since the Unix epoch, of midnight for the start of the service date for the trip.

Returns:

  • (Integer) 


94
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 94

required :service_date, Integer, api_name: :serviceDate

#situation_ids ⇒ Array<String>?

References to situation elements (if any) applicable to this arrival.

Returns:

  • (Array<String>, nil) 


230
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 230

optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds

#status ⇒ String?

Current status of the arrival.

Returns:

  • (String, nil) 


236
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 236

optional :status, String

#stop_id ⇒ String

The ID of the stop the vehicle is arriving at.

Returns:

  • (String) 


100
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 100

required :stop_id, String, api_name: :stopId

#stop_sequence ⇒ Integer

Index of the stop into the sequence of stops that make up the trip for this arrival.

Returns:

  • (Integer) 


107
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 107

required :stop_sequence, Integer, api_name: :stopSequence

#total_stops_in_trip ⇒ Integer

Total number of stops visited on the trip for this arrival.

Returns:

  • (Integer) 


113
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 113

required :total_stops_in_trip, Integer, api_name: :totalStopsInTrip

#trip_headsign ⇒ String

Optional trip headsign that potentially overrides the trip headsign in the referenced trip element.

Returns:

  • (String) 


120
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 120

required :trip_headsign, String, api_name: :tripHeadsign

#trip_id ⇒ String

The ID of the trip for the arriving vehicle.

Returns:

  • (String) 


126
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 126

required :trip_id, String, api_name: :tripId

#trip_status ⇒ OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus?

Trip-specific status for the arriving transit vehicle.

Returns:



242
243
244
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 242

optional :trip_status,
-> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus },
api_name: :tripStatus

#vehicle_id ⇒ String

ID of the transit vehicle serving this trip.

Returns:

  • (String) 


132
 
# File 'lib/onebusaway_sdk/models/arrival_and_departure_retrieve_response.rb', line 132

required :vehicle_id, String, api_name: :vehicleId