Class: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status

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

Overview

See Also:

Defined Under Namespace

Classes: LastKnownLocation, Position

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(lat: nil, lon: nil) ⇒ Object

Last known location of the transit vehicle.

Parameters:

  • lat (Float) (defaults to: nil)

    Latitude of the last known location of the transit vehicle.

  • lon (Float) (defaults to: nil)

    Longitude of the last known location of the transit vehicle.



# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 319


Instance Attribute Details

#active_trip_idString

Trip ID of the trip the vehicle is actively serving.

Returns:

  • (String)


153
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 153

required :active_trip_id, String, api_name: :activeTripId

#block_trip_sequenceInteger

Index of the active trip into the sequence of trips for the active block.

Returns:

  • (Integer)


159
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 159

required :block_trip_sequence, Integer, api_name: :blockTripSequence

#closest_stopString

ID of the closest stop to the current location of the transit vehicle.

Returns:

  • (String)


165
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 165

required :closest_stop, String, api_name: :closestStop

#closest_stop_time_offsetInteger?

Time offset from the closest stop to the current position of the transit vehicle (in seconds).

Returns:

  • (Integer, nil)


252
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 252

optional :closest_stop_time_offset, Integer, api_name: :closestStopTimeOffset

#distance_along_tripFloat

Distance, in meters, the transit vehicle has progressed along the active trip.

Returns:

  • (Float)


171
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 171

required :distance_along_trip, Float, api_name: :distanceAlongTrip

#frequencyString?

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

Returns:

  • (String, nil)


258
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 258

optional :frequency, String

#last_known_distance_along_tripFloat

Last known distance along the trip received in real-time from the transit vehicle.

Returns:

  • (Float)


178
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 178

required :last_known_distance_along_trip, Float, api_name: :lastKnownDistanceAlongTrip

#last_known_locationOnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::LastKnownLocation?

Last known location of the transit vehicle.



264
265
266
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 264

optional :last_known_location,
-> { OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::LastKnownLocation },
api_name: :lastKnownLocation

#last_known_orientationFloat?

Last known orientation value received in real-time from the transit vehicle.

Returns:

  • (Float, nil)


272
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 272

optional :last_known_orientation, Float, api_name: :lastKnownOrientation

#last_location_update_timeInteger

Timestamp of the last known real-time location update from the transit vehicle.

Returns:

  • (Integer)


184
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 184

required :last_location_update_time, Integer, api_name: :lastLocationUpdateTime

#last_update_timeInteger

Timestamp of the last known real-time update from the transit vehicle.

Returns:

  • (Integer)


190
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 190

required :last_update_time, Integer, api_name: :lastUpdateTime

#next_stopString?

ID of the next stop the transit vehicle is scheduled to arrive at.

Returns:

  • (String, nil)


278
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 278

optional :next_stop, String, api_name: :nextStop

#next_stop_time_offsetInteger?

Time offset from the next stop to the current position of the transit vehicle (in seconds).

Returns:

  • (Integer, nil)


285
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 285

optional :next_stop_time_offset, Integer, api_name: :nextStopTimeOffset

#occupancy_capacityInteger

Capacity of the transit vehicle in terms of occupancy.

Returns:

  • (Integer)


196
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 196

required :occupancy_capacity, Integer, api_name: :occupancyCapacity

#occupancy_countInteger

Current count of occupants in the transit vehicle.

Returns:

  • (Integer)


202
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 202

required :occupancy_count, Integer, api_name: :occupancyCount

#occupancy_statusString

Current occupancy status of the transit vehicle.

Returns:

  • (String)


208
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 208

required :occupancy_status, String, api_name: :occupancyStatus

#orientationFloat?

Orientation of the transit vehicle, represented as an angle in degrees.

Returns:

  • (Float, nil)


291
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 291

optional :orientation, Float

#phaseString

Current journey phase of the trip.

Returns:

  • (String)


214
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 214

required :phase, String

#positionOnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::Position?

Current position of the transit vehicle.



297
298
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 297

optional :position,
-> { OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::Position }

#predictedBoolean

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

Returns:

  • (Boolean)


220
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 220

required :predicted, OnebusawaySDK::Internal::Type::Boolean

#schedule_deviationInteger

Deviation from the schedule in seconds (positive for late, negative for early).

Returns:

  • (Integer)


226
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 226

required :schedule_deviation, Integer, api_name: :scheduleDeviation

#scheduled_distance_along_tripFloat?

Distance, in meters, the transit vehicle is scheduled to have progressed along the active trip.

Returns:

  • (Float, nil)


305
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 305

optional :scheduled_distance_along_trip, Float, api_name: :scheduledDistanceAlongTrip

#service_dateInteger

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

Returns:

  • (Integer)


233
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 233

required :service_date, Integer, api_name: :serviceDate

#situation_idsArray<String>?

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

Returns:

  • (Array<String>, nil)


311
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 311

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

#statusString

Current status modifiers for the trip.

Returns:

  • (String)


239
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 239

required :status, String

#total_distance_along_tripFloat

Total length of the trip, in meters.

Returns:

  • (Float)


245
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 245

required :total_distance_along_trip, Float, api_name: :totalDistanceAlongTrip

#vehicle_idString?

ID of the transit vehicle currently serving the trip.

Returns:

  • (String, nil)


317
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_response.rb', line 317

optional :vehicle_id, String, api_name: :vehicleId