Route

class Route constructor(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, junctionViews: List<JunctionViewInformation> = emptyList())

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

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.

junctionViews

List containing views of junctions along the route.

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)
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, junctionViews: List<JunctionViewInformation> = emptyList())

Properties

Link copied to clipboard
Link copied to clipboard

Returns the destination of the route.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
val id: RouteId
Link copied to clipboard
Link copied to clipboard

Returns the origin of the route.

Link copied to clipboard

Important: This is a Public Preview API. It may be changed or removed at any time.

Link copied to clipboard

Important: This is a Public Preview API. It may be changed or removed at any time.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String