HapiLeg

data class HapiLeg(idx: Int, name: String?, number: String?, category: String?, type: HapiLeg.Type?, cancelled: Boolean, partCancelled: Boolean, reachable: Boolean, redirected: Boolean, direction: String?, duration: Duration?, dist: Int?, hide: Boolean, psCtxArriveEarlier: String?, psCtxDepartureLater: String?, Origin: HapiOrigin, Destination: HapiDestination, Notes: List<HapiNote>, JourneyDetailRef: String?, Freq: HapiFrequency?, GisRef: String?, GisRoute: HapiGisRoute?, Messages: List<HapiMessage>, JourneyStatus: HapiJourneyStatus?, Product: List<HapiProduct>, Polyline: HapiPolyline?, PolylineGroup: HapiPolylineGroup?, Stops: List<HapiStop>, ServiceDays: List<HapiServiceDays>, ParallelJourney: List<HapiJourney>, Occupancy: List<HapiOccupancy>)

Types

Type

enum Type : Enum<HapiLeg.Type>

Properties

cancelled

val cancelled: Boolean = false

Will be true if this journey is cancelled.

category

val category: String?

The train category name. The category assignments are stored in the "zugart" file of the raw Hafas plan data.

Destination

val Destination: HapiDestination

direction

val direction: String?

Direction information. This will be the name of the last station of the train's journey. Call the JourneyDetail service to get detailed information about the train journey.

dist

val dist: Int?

Distance for this leg in meter.

duration

val duration: Duration?

The duration.

Freq

val Freq: HapiFrequency?

GisRef

val GisRef: String?

GisRoute

val GisRoute: HapiGisRoute?

hide

val hide: Boolean = false

Will be true if this journey is hidden.

idx

val idx: Int

Specifies the index of the leg starting from 0 and incrementing by 1. It corresponds to travel-order ascending; unique within composite Trip.

JourneyDetailRef

val JourneyDetailRef: String?

JourneyStatus

val JourneyStatus: HapiJourneyStatus? = null

Messages

val Messages: List<HapiMessage>

name

val name: String?

The attribute name specifies the name of the leg (e.g. "Bus 100").

Notes

val Notes: List<HapiNote>

number

val number: String?

The train number.

Occupancy

val Occupancy: List<HapiOccupancy>

Origin

val Origin: HapiOrigin

ParallelJourney

val ParallelJourney: List<HapiJourney>

partCancelled

val partCancelled: Boolean = false

Will be true if this journey is partially cancelled.

Polyline

val Polyline: HapiPolyline?

PolylineGroup

val PolylineGroup: HapiPolylineGroup?

Product

val Product: List<HapiProduct>

psCtxArriveEarlier

val psCtxArriveEarlier: String?

Provides a context that may be used in service PartialSearch to increase the time for interchange between the previous journey arrival stop and the following journey departure stop by searching a trip that will lead to an earlier arrival time for the previous journey while keeping the departure time for the following journey(s) constant.

psCtxDepartureLater

val psCtxDepartureLater: String?

Provides a context that may be used in service PartialSearch to increase the time for interchange between the previous journey arrival stop and the following journey departure stop by searching a trip that will lead to a later departure time for the following journey while keeping the arrival time for the previous journey(s) constant

reachable

val reachable: Boolean = true

Will be true if this journey is reachable.

redirected

val redirected: Boolean = false

Will be true if this journey is redirected.

ServiceDays

val ServiceDays: List<HapiServiceDays>

Stops

val Stops: List<HapiStop>

type

val type: HapiLeg.Type? = null

The attribute type specifies the type of the leg. The value can be the JNY for public transport or WALK, TRSF (transfer), BIKE, KISS (car), PARK (Park and Ride) or TAXI, CHKI (check-in), CHKO (check-out) or TETA (Tele taxi).