Class: OnebusawaySDK::Models::TripsForRouteListResponse::Data::List

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

Defined Under Namespace

Classes: Schedule, Status

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_time: nil, departure_time: nil, distance_along_trip: nil, historical_occupancy: nil, stop_headsign: nil, stop_id: nil) ⇒ Object

Parameters:

  • arrival_time (Integer) (defaults to: nil)
  • departure_time (Integer) (defaults to: nil)
  • distance_along_trip (Float) (defaults to: nil)
  • historical_occupancy (String) (defaults to: nil)
  • stop_headsign (String) (defaults to: nil)
  • stop_id (String) (defaults to: nil) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 37

class List < OnebusawaySDK::Internal::Type::BaseModel
  # @!attribute schedule
  #
  #   @return [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule]
  required :schedule, -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule }

  # @!attribute status
  #
  #   @return [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status]
  required :status, -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status }

  # @!attribute trip_id
  #
  #   @return [String]
  required :trip_id, String, api_name: :tripId

  # @!attribute frequency
  #
  #   @return [String, nil]
  optional :frequency, String, nil?: true

  # @!attribute service_date
  #
  #   @return [Integer, nil]
  optional :service_date, Integer, api_name: :serviceDate

  # @!attribute situation_ids
  #
  #   @return [Array<String>, nil]
  optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds

  # @!method initialize(schedule:, status:, trip_id:, frequency: nil, service_date: nil, situation_ids: nil)
  #   @param schedule [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule]
  #   @param status [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status]
  #   @param trip_id [String]
  #   @param frequency [String, nil]
  #   @param service_date [Integer]
  #   @param situation_ids [Array<String>]

  # @see OnebusawaySDK::Models::TripsForRouteListResponse::Data::List#schedule
  class Schedule < OnebusawaySDK::Internal::Type::BaseModel
    # @!attribute next_trip_id
    #
    #   @return [String]
    required :next_trip_id, String, api_name: :nextTripId

    # @!attribute previous_trip_id
    #
    #   @return [String]
    required :previous_trip_id, String, api_name: :previousTripId

    # @!attribute stop_times
    #
    #   @return [Array<OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule::StopTime>]
    required :stop_times,
             -> { OnebusawaySDK::Internal::Type::ArrayOf[OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule::StopTime] },
             api_name: :stopTimes

    # @!attribute time_zone
    #
    #   @return [String]
    required :time_zone, String, api_name: :timeZone

    # @!attribute frequency
    #
    #   @return [String, nil]
    optional :frequency, String, nil?: true

    # @!method initialize(next_trip_id:, previous_trip_id:, stop_times:, time_zone:, frequency: nil)
    #   @param next_trip_id [String]
    #   @param previous_trip_id [String]
    #   @param stop_times [Array<OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule::StopTime>]
    #   @param time_zone [String]
    #   @param frequency [String, nil]

    class StopTime < OnebusawaySDK::Internal::Type::BaseModel
      # @!attribute arrival_time
      #
      #   @return [Integer, nil]
      optional :arrival_time, Integer, api_name: :arrivalTime

      # @!attribute departure_time
      #
      #   @return [Integer, nil]
      optional :departure_time, Integer, api_name: :departureTime

      # @!attribute distance_along_trip
      #
      #   @return [Float, nil]
      optional :distance_along_trip, Float, api_name: :distanceAlongTrip

      # @!attribute historical_occupancy
      #
      #   @return [String, nil]
      optional :historical_occupancy, String, api_name: :historicalOccupancy

      # @!attribute stop_headsign
      #
      #   @return [String, nil]
      optional :stop_headsign, String, api_name: :stopHeadsign

      # @!attribute stop_id
      #
      #   @return [String, nil]
      optional :stop_id, String, api_name: :stopId

      # @!method initialize(arrival_time: nil, departure_time: nil, distance_along_trip: nil, historical_occupancy: nil, stop_headsign: nil, stop_id: nil)
      #   @param arrival_time [Integer]
      #   @param departure_time [Integer]
      #   @param distance_along_trip [Float]
      #   @param historical_occupancy [String]
      #   @param stop_headsign [String]
      #   @param stop_id [String]
    end
  end

  # @see OnebusawaySDK::Models::TripsForRouteListResponse::Data::List#status
  class Status < OnebusawaySDK::Internal::Type::BaseModel
    # @!attribute active_trip_id
    #   Trip ID of the trip the vehicle is actively serving.
    #
    #   @return [String]
    required :active_trip_id, String, api_name: :activeTripId

    # @!attribute block_trip_sequence
    #   Index of the active trip into the sequence of trips for the active block.
    #
    #   @return [Integer]
    required :block_trip_sequence, Integer, api_name: :blockTripSequence

    # @!attribute closest_stop
    #   ID of the closest stop to the current location of the transit vehicle.
    #
    #   @return [String]
    required :closest_stop, String, api_name: :closestStop

    # @!attribute distance_along_trip
    #   Distance, in meters, the transit vehicle has progressed along the active trip.
    #
    #   @return [Float]
    required :distance_along_trip, Float, api_name: :distanceAlongTrip

    # @!attribute last_known_distance_along_trip
    #   Last known distance along the trip received in real-time from the transit
    #   vehicle.
    #
    #   @return [Float]
    required :last_known_distance_along_trip, Float, api_name: :lastKnownDistanceAlongTrip

    # @!attribute last_location_update_time
    #   Timestamp of the last known real-time location update from the transit vehicle.
    #
    #   @return [Integer]
    required :last_location_update_time, Integer, api_name: :lastLocationUpdateTime

    # @!attribute last_update_time
    #   Timestamp of the last known real-time update from the transit vehicle.
    #
    #   @return [Integer]
    required :last_update_time, Integer, api_name: :lastUpdateTime

    # @!attribute occupancy_capacity
    #   Capacity of the transit vehicle in terms of occupancy.
    #
    #   @return [Integer]
    required :occupancy_capacity, Integer, api_name: :occupancyCapacity

    # @!attribute occupancy_count
    #   Current count of occupants in the transit vehicle.
    #
    #   @return [Integer]
    required :occupancy_count, Integer, api_name: :occupancyCount

    # @!attribute occupancy_status
    #   Current occupancy status of the transit vehicle.
    #
    #   @return [String]
    required :occupancy_status, String, api_name: :occupancyStatus

    # @!attribute phase
    #   Current journey phase of the trip.
    #
    #   @return [String]
    required :phase, String

    # @!attribute predicted
    #   Indicates if real-time arrival info is available for this trip.
    #
    #   @return [Boolean]
    required :predicted, OnebusawaySDK::Internal::Type::Boolean

    # @!attribute schedule_deviation
    #   Deviation from the schedule in seconds (positive for late, negative for early).
    #
    #   @return [Integer]
    required :schedule_deviation, Integer, api_name: :scheduleDeviation

    # @!attribute service_date
    #   Time, in milliseconds since the Unix epoch, of midnight for the start of the
    #   service date for the trip.
    #
    #   @return [Integer]
    required :service_date, Integer, api_name: :serviceDate

    # @!attribute status
    #   Current status modifiers for the trip.
    #
    #   @return [String]
    required :status, String

    # @!attribute total_distance_along_trip
    #   Total length of the trip, in meters.
    #
    #   @return [Float]
    required :total_distance_along_trip, Float, api_name: :totalDistanceAlongTrip

    # @!attribute closest_stop_time_offset
    #   Time offset from the closest stop to the current position of the transit vehicle
    #   (in seconds).
    #
    #   @return [Integer, nil]
    optional :closest_stop_time_offset, Integer, api_name: :closestStopTimeOffset

    # @!attribute frequency
    #   Information about frequency-based scheduling, if applicable to the trip.
    #
    #   @return [String, nil]
    optional :frequency, String

    # @!attribute last_known_location
    #   Last known location of the transit vehicle.
    #
    #   @return [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::LastKnownLocation, nil]
    optional :last_known_location,
             -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::LastKnownLocation },
             api_name: :lastKnownLocation

    # @!attribute last_known_orientation
    #   Last known orientation value received in real-time from the transit vehicle.
    #
    #   @return [Float, nil]
    optional :last_known_orientation, Float, api_name: :lastKnownOrientation

    # @!attribute next_stop
    #   ID of the next stop the transit vehicle is scheduled to arrive at.
    #
    #   @return [String, nil]
    optional :next_stop, String, api_name: :nextStop

    # @!attribute next_stop_time_offset
    #   Time offset from the next stop to the current position of the transit vehicle
    #   (in seconds).
    #
    #   @return [Integer, nil]
    optional :next_stop_time_offset, Integer, api_name: :nextStopTimeOffset

    # @!attribute orientation
    #   Orientation of the transit vehicle, represented as an angle in degrees.
    #
    #   @return [Float, nil]
    optional :orientation, Float

    # @!attribute position
    #   Current position of the transit vehicle.
    #
    #   @return [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::Position, nil]
    optional :position, -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::Position }

    # @!attribute scheduled_distance_along_trip
    #   Distance, in meters, the transit vehicle is scheduled to have progressed along
    #   the active trip.
    #
    #   @return [Float, nil]
    optional :scheduled_distance_along_trip, Float, api_name: :scheduledDistanceAlongTrip

    # @!attribute situation_ids
    #   References to situation elements (if any) applicable to this trip.
    #
    #   @return [Array<String>, nil]
    optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds

    # @!attribute vehicle_id
    #   ID of the transit vehicle currently serving the trip.
    #
    #   @return [String, nil]
    optional :vehicle_id, String, api_name: :vehicleId

    # @!method initialize(active_trip_id:, block_trip_sequence:, closest_stop:, distance_along_trip:, last_known_distance_along_trip:, last_location_update_time:, last_update_time:, occupancy_capacity:, occupancy_count:, occupancy_status:, phase:, predicted:, schedule_deviation:, service_date:, status:, total_distance_along_trip:, closest_stop_time_offset: nil, frequency: nil, last_known_location: nil, last_known_orientation: nil, next_stop: nil, next_stop_time_offset: nil, orientation: nil, position: nil, scheduled_distance_along_trip: nil, situation_ids: nil, vehicle_id: nil)
    #   Some parameter documentations has been truncated, see
    #   {OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status} for more
    #   details.
    #
    #   @param active_trip_id [String] Trip ID of the trip the vehicle is actively serving.
    #
    #   @param block_trip_sequence [Integer] Index of the active trip into the sequence of trips for the active block.
    #
    #   @param closest_stop [String] ID of the closest stop to the current location of the transit vehicle.
    #
    #   @param distance_along_trip [Float] Distance, in meters, the transit vehicle has progressed along the active trip.
    #
    #   @param last_known_distance_along_trip [Float] Last known distance along the trip received in real-time from the transit vehicl
    #
    #   @param last_location_update_time [Integer] Timestamp of the last known real-time location update from the transit vehicle.
    #
    #   @param last_update_time [Integer] Timestamp of the last known real-time update from the transit vehicle.
    #
    #   @param occupancy_capacity [Integer] Capacity of the transit vehicle in terms of occupancy.
    #
    #   @param occupancy_count [Integer] Current count of occupants in the transit vehicle.
    #
    #   @param occupancy_status [String] Current occupancy status of the transit vehicle.
    #
    #   @param phase [String] Current journey phase of the trip.
    #
    #   @param predicted [Boolean] Indicates if real-time arrival info is available for this trip.
    #
    #   @param schedule_deviation [Integer] Deviation from the schedule in seconds (positive for late, negative for early).
    #
    #   @param service_date [Integer] Time, in milliseconds since the Unix epoch, of midnight for the start of the ser
    #
    #   @param status [String] Current status modifiers for the trip.
    #
    #   @param total_distance_along_trip [Float] Total length of the trip, in meters.
    #
    #   @param closest_stop_time_offset [Integer] Time offset from the closest stop to the current position of the transit vehicle
    #
    #   @param frequency [String] Information about frequency-based scheduling, if applicable to the trip.
    #
    #   @param last_known_location [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::LastKnownLocation] Last known location of the transit vehicle.
    #
    #   @param last_known_orientation [Float] Last known orientation value received in real-time from the transit vehicle.
    #
    #   @param next_stop [String] ID of the next stop the transit vehicle is scheduled to arrive at.
    #
    #   @param next_stop_time_offset [Integer] Time offset from the next stop to the current position of the transit vehicle (i
    #
    #   @param orientation [Float] Orientation of the transit vehicle, represented as an angle in degrees.
    #
    #   @param position [OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::Position] Current position of the transit vehicle.
    #
    #   @param scheduled_distance_along_trip [Float] Distance, in meters, the transit vehicle is scheduled to have progressed along t
    #
    #   @param situation_ids [Array<String>] References to situation elements (if any) applicable to this trip.
    #
    #   @param vehicle_id [String] ID of the transit vehicle currently serving the trip.

    # @see OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status#last_known_location
    class LastKnownLocation < OnebusawaySDK::Internal::Type::BaseModel
      # @!attribute lat
      #   Latitude of the last known location of the transit vehicle.
      #
      #   @return [Float, nil]
      optional :lat, Float

      # @!attribute lon
      #   Longitude of the last known location of the transit vehicle.
      #
      #   @return [Float, nil]
      optional :lon, Float

      # @!method initialize(lat: nil, lon: nil)
      #   Last known location of the transit vehicle.
      #
      #   @param lat [Float] Latitude of the last known location of the transit vehicle.
      #
      #   @param lon [Float] Longitude of the last known location of the transit vehicle.
    end

    # @see OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status#position
    class Position < OnebusawaySDK::Internal::Type::BaseModel
      # @!attribute lat
      #   Latitude of the current position of the transit vehicle.
      #
      #   @return [Float, nil]
      optional :lat, Float

      # @!attribute lon
      #   Longitude of the current position of the transit vehicle.
      #
      #   @return [Float, nil]
      optional :lon, Float

      # @!method initialize(lat: nil, lon: nil)
      #   Current position of the transit vehicle.
      #
      #   @param lat [Float] Latitude of the current position of the transit vehicle.
      #
      #   @param lon [Float] Longitude of the current position of the transit vehicle.
    end
  end
end

Instance Attribute Details

#frequency ⇒ String?

Returns:

  • (String, nil) 


56
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 56

optional :frequency, String, nil?: true

#schedule ⇒ OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule

Returns:



41
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 41

required :schedule, -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Schedule }

#service_date ⇒ Integer?

Returns:

  • (Integer, nil) 


61
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 61

optional :service_date, Integer, api_name: :serviceDate

#situation_ids ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


66
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 66

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

#status ⇒ OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status

Returns:



46
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 46

required :status, -> { OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status }

#trip_id ⇒ String

Returns:

  • (String) 


51
 
# File 'lib/onebusaway_sdk/models/trips_for_route_list_response.rb', line 51

required :trip_id, String, api_name: :tripId