Route

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

Parameters

id

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.

guidanceProgressOffset

The offset where incremental computation of route contents was paused.

planningReason

The reason why the route was planned.