com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route/Route

Route

class Route

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

Constructors

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)

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

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

Properties

val computedAs: ComputedAs

Defines whether it was an optimal route that was computed based on chosen parameters, or it was an alternative route.

val destination: RouteStop

Returns the destination of the route.

val forkPoints: List<ForkPoint>

List containing fork points with other routes.

val geometry: List<GeoPoint>

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

guidanceProgressOffset

val guidanceProgressOffset: Distance

The offset where incremental computation of route contents was paused.

val id: RouteId

Unique ID.

val legs: List<RouteLeg>

List of route legs.

modificationHistory

val modificationHistory: RouteModificationHistory

Information about route creation and the last route update.

val origin: RouteStop

Returns the origin of the route.

val plannedWith: RoutePlanningOptions?

The options used to generate this route.

val planningReason: PlanningReason

The reason why the route was planned.

val routePoints: List<RoutePoint>

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

val routeStops: List<RouteStop>

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

val sections: Sections

Information about sections of the route.

val summary: Summary

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

val waypoints: List<RouteStop>

Returns the list of waypoints of the route.

Functions

consumptionInLegUpTo

fun consumptionInLegUpTo(routeOffset: Distance, withAuxPower: AuxiliaryPower? = null): Result<Consumption>

Calculates the electric energy used up to routeOffset, starting from the preceding waypoint or origin.

open operator override fun equals(other: Any?): Boolean

Checks if this Route object is equal to another object.

open override fun hashCode(): Int

Get the hash code of this route object.

remainingBudgetAt

fun remainingBudgetAt(routeOffset: Distance, withAuxPower: AuxiliaryPower? = null): Result<Consumption>

Calculates the remaining battery charge at a given distance along the route.

open override fun toString(): String

Returns a string representation of this Route object.

fun travelTimeUpTo(routeOffset: Distance): Result<Duration>

Calculates the travel time up to a given distance along the route.