Citymapper SDK/com.citymapper.sdk.core.transit/Route

Route

data class Route(signature: Signature, ancestorResult: AncestorResultIdentifier, legs: List<Leg>, start: Waypoint, end: Waypoint, profileDetail: ProfileDetail?, duration: Duration?, durationAccuracy: DurationAccuracy, price: Price?, departureTime: Date?, arrivalTime: Date?)

Properties

ancestorResult

val ancestorResult: AncestorResultIdentifier

Identifies the ancestor result for a Route. Two Routes have the same identifier if they are descendants from the same original routing result, even if they now have different signatures. This allows treating updates to a Route (for example, due to re-routing events) as the "same" route from a user-facing point of view

arrivalTime

val arrivalTime: Date? = null

departureTime

val departureTime: Date? = null

duration

val duration: Duration? = null

durationAccuracy

val durationAccuracy: DurationAccuracy

end

val end: Waypoint

legs

val legs: List<Leg>

price

val price: Price? = null

profile

val profile: Profile?

profileDetail

val profileDetail: ProfileDetail?

seedSignature

~~val~~ ~~seedSignature~~: Signature

When a Route is re-planned, the the resulting Route will have a different signature. This will hold the signature of the Route that is the oldest ancestor of this one.

signature

val signature: Signature

The signature uniquely identifies this route.

start

val start: Waypoint

Extensions

firstLegWithService

fun Route.firstLegWithService(): Leg?

firstVehicleLeg

fun Route.firstVehicleLeg(): Leg?

getFirstLegOfType

inline fun <T : Leg> Route.getFirstLegOfType(): T?

getPathSegments

fun Route.getPathSegments(): PathGeometrySegments

hasUnlockableVehicle

fun Route.hasUnlockableVehicle(): Boolean