EfaJourney

data class EfaJourney(stopID: Long, x: Double, y: Double, mapName: EfaCoordinateSystem, area: String, platform: String?, platformName: String?, stopName: String, nameWO: String, gid: String?, pointGid: String?, pointType: String?, countdown: Duration, occupancy: EfaJourney.Occupancy?, dateTime: LocalDateTime, realDateTime: LocalDateTime?, realtimeTripStatus: Set<EfaJourney.RealtimeStatus>, servingLine: EfaServingLine, operator: EfaOperator?, prevStopSeq: List<EfaStop>?, onwardStopSeq: List<EfaStop>?)

Describes the json structure encoding journeys from the XML_DM_REQUEST endpoint. Appears at $.departureList[] and $.arrivalList[]

Constructors

EfaJourney
Link copied to clipboard
fun EfaJourney(stopID: Long, x: Double, y: Double, mapName: EfaCoordinateSystem, area: String, platform: String?, platformName: String?, stopName: String, nameWO: String, gid: String?, pointGid: String?, pointType: String?, countdown: Duration, occupancy: EfaJourney.Occupancy? = null, dateTime: LocalDateTime, realDateTime: LocalDateTime?, realtimeTripStatus: Set<EfaJourney.RealtimeStatus> = emptySet(), servingLine: EfaServingLine, operator: EfaOperator?, prevStopSeq: List<EfaStop>?, onwardStopSeq: List<EfaStop>?)

Types

Occupancy
Link copied to clipboard
enum Occupancy : Enum<EfaJourney.Occupancy>

Describes a vehicle's current occupancy status on a journey

RealtimeStatus
Link copied to clipboard
enum RealtimeStatus : Enum<EfaJourney.RealtimeStatus>

Describes the realtime information status of a journey

Properties

area
Link copied to clipboard
val area: String

TODO: Purpose?

countdown
Link copied to clipboard
val countdown: Duration

Returns a countdown to this journey's departure/arrival relative to the request time

dateTime
Link copied to clipboard
val dateTime: LocalDateTime

The scheduled date and time of the arrival/departure event

gid
Link copied to clipboard
val gid: String?

The global id of the stop where this journey is observed

mapName
Link copied to clipboard
val mapName: EfaCoordinateSystem

The coordinate system that was used to encode the coordinates

nameWO
Link copied to clipboard
val nameWO: String

The name of the stop, but without a place

occupancy
Link copied to clipboard
val occupancy: EfaJourney.Occupancy? = null

The occupancy information of the journey at this stop, if available

onwardStopSeq
Link copied to clipboard
val onwardStopSeq: List<EfaStop>?

The sequence of en-route stops that succeed the one observed

operator
Link copied to clipboard
val operator: EfaOperator?

The operator of this journey

platform
Link copied to clipboard
val platform: String?

The code of the platform at which the vehicle stops

platformName
Link copied to clipboard
val platformName: String?

Returns a human readable name of the platform at which the vehicle stops

pointGid
Link copied to clipboard
val pointGid: String?

The global id of ???

pointType
Link copied to clipboard
val pointType: String?

TODO: Purpose?

prevStopSeq
Link copied to clipboard
val prevStopSeq: List<EfaStop>?

The sequence of en-route stops that precede the one observed

realDateTime
Link copied to clipboard
val realDateTime: LocalDateTime?

The realtime date and time of the arrival/departure event, if available

realtimeTripStatus
Link copied to clipboard
val realtimeTripStatus: Set<EfaJourney.RealtimeStatus>

The status of the realtime information associated with this journey

servingLine
Link copied to clipboard
val servingLine: EfaServingLine

The line serving this journey

stopID
Link copied to clipboard
val stopID: Long

The id of the stop where this journey is observed

stopName
Link copied to clipboard
val stopName: String

The name of the stop where this journey is observed

x
Link copied to clipboard
val x: Double

The x-coordinate of the stop position

y
Link copied to clipboard
val y: Double

The y-coordinate of the stop position