Route

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 guidanceProgressOffset: Distance = Distance.ZERO, val computedAs: ComputedAs = ComputedAs.Primary, val routePoints: List<RoutePoint> = emptyList(), val planningReason: PlanningReason = PlanningReason.Requested)

The route represents the result of the route planning including geometry and generated instructions.

Constructors

Link copied to clipboard
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, plannedWith: RoutePlanningOptions? = null)

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

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)

Properties

Link copied to clipboard

Determines if the route was computed as primary or as a path alternative with regards to the given cost model.

Link copied to clipboard

Returns the destination of the route.

Link copied to clipboard

List containing fork points with other routes.

Link copied to clipboard

Returns all GeoPoints of this route. Route points do not contain duplicates on leg intersections.

Link copied to clipboard

The offset where incremental computation of route contents was paused.

Link copied to clipboard
val id: RouteId

Unique ID.

Link copied to clipboard

List of route legs.

Link copied to clipboard

Information about route creation and the last route update.

Link copied to clipboard

Returns the origin of the route.

Link copied to clipboard

The options used to generate this route.

Link copied to clipboard

The reason why the route was planned.

Link copied to clipboard

Optional extended representation of the route. Route points do not contain duplicates on leg intersections.

Link copied to clipboard

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

Link copied to clipboard

Information about sections of the route.

Link copied to clipboard

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

Link copied to clipboard

Returns the list of waypoints of the route.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks if this Route object is equal to another object.

Link copied to clipboard
open override fun hashCode(): Int

Get the hash code of this route object.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of this Route object.