Route

data class Route(val id: RouteId, val summary: Summary, val legs: List<RouteLeg>, val routeStops: List<RouteStop>, val sections: Sections, val modificationHistory: RouteModificationHistory, val forkPoints: List<ForkPoint> = emptyList(), val incrementEndOffset: <Error class: unknown class> = Distance.ZERO, val computedAs: ComputedAs = ComputedAs.Primary, val routePoints: List<RoutePoint> = emptyList(), val planningReason: PlanningReason = PlanningReason.Requested)

The route class contains the route to be navigated, including geometry and generated guidance messages.

Unique ID.

summary

A collection of data fields representing the properties of the route.

legs

List of route legs.

routeStops

List containing every route stop along the route, including origin and destination.

sections

Information about sections of the route.

modificationHistory

Information about route creation and last route update.

routePoints

Optional extended representation of the route.

Route points do not contain duplicates on leg intersections.

forkPoints

List containing fork points with other routes.

incrementEndOffset

Position where the last increment generation has ended or 0 if the first increment is being requested.

planningReason

The reason why the route was planned.

Constructors

constructor(id: RouteId, summary: Summary, legs: List<RouteLeg>, routeStops: List<RouteStop>, sections: Sections, modificationHistory: RouteModificationHistory, forkPoints: List<ForkPoint> = emptyList(), incrementEndOffset: <Error class: unknown class> = Distance.ZERO, computedAs: ComputedAs = ComputedAs.Primary, routePoints: List<RoutePoint> = emptyList(), planningReason: PlanningReason = PlanningReason.Requested)