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

Package-level declarations

Types

Determines if the route was computed as primary with regards to the given cost model, or if it is a path alternative, meaning a distinct path depending on the previous computed routes.

Consumption

abstract class Consumption

Represents a consumed or remaining amount of fuel or electric energy.

Destination

data class Destination(val id: RouteStopId, val place: <Error class: unknown class>, val navigableCoordinates: List<<Error class: unknown class>>, val routeOffset: <Error class: unknown class>, val roadSide: RoadSide? = null, val arrivalEnergy: <Error class: unknown class>? = null, val sourceType: RouteStop.SourceType = RouteStop.SourceType.UserDefined, val chargingInformation: <Error class: unknown class>? = null) : RouteStop

Represents the destination of the route.

DrivingSide

enum DrivingSide : Enum<DrivingSide>

Indicates driving side at the point of the maneuver.

ForkPoint

data class ForkPoint(val forkingRouteId: RouteId, val location: <Error class: unknown class>)

Represents information about the fork point.

Origin

data class Origin(val id: RouteStopId, val place: <Error class: unknown class>, val navigableCoordinates: List<<Error class: unknown class>>, val routeOffset: <Error class: unknown class>, val roadSide: RoadSide? = null, val arrivalEnergy: <Error class: unknown class>? = null, val sourceType: RouteStop.SourceType = RouteStop.SourceType.UserDefined, val chargingInformation: <Error class: unknown class>? = null) : RouteStop

Represents the origin of the route.

PlanningReason

value class PlanningReason

Represents the planning reason returned from the route planner.

RoadSide

enum RoadSide : Enum<RoadSide>

Indicates the side of the road at which a RouteStop is located.

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.

RouteId

value class RouteId(val value: <Error class: unknown class> = UniqueId())

A unique identifier of a Route.

RouteLeg

data class RouteLeg(val points: List<<Error class: unknown class>>, val instructions: List<Instruction>, val summary: Summary, val mapReferences: <Error class: unknown class>? = null)

Represents information about a part of a Route, made up of a list of GeoPoint points. Contains a list of Instructions for all the maneuvers along the route leg.

RouteModificationHistory

data class RouteModificationHistory(val creation: RouteTimestamp, val lastUpdate: RouteTimestamp = creation)

Information about the route creation and the last update.

RoutePoint

data class RoutePoint(val coordinate: <Error class: unknown class>, val routeOffset: <Error class: unknown class>, val travelTime: <Error class: unknown class>)

Represents route GeoPoint together with its distance offset along the route and estimated travel time.

RouteStop

interface RouteStop

Represents a point that the route must visit.

RouteStopId

value class RouteStopId(val value: UUID = UUID.randomUUID())

A unique identifier, used for matching RouteStop with ItineraryPoint.

RouteTimestamp

data class RouteTimestamp(val timestampInMillis: Long, val timeWithZone: Calendar)

Information about route creation or modification time.

Segment

class Segment(val start: RoutePoint, val end: RoutePoint)

Represents a line between two RoutePoint.

Signpost

data class Signpost(val exitNumber: TextWithPhonetics? = null, val exitName: TextWithPhonetics? = null, val towardName: TextWithPhonetics? = null)

The Signpost class contains information about the signpost for the Instruction.

Summary

data class Summary(val length: <Error class: unknown class>, val travelTime: <Error class: unknown class>, val trafficDelay: <Error class: unknown class> = Duration.ZERO, val trafficLength: <Error class: unknown class> = Distance.ZERO, val departureTimeWithZone: Calendar, val arrivalTimeWithZone: Calendar, val consumptionForWholeLength: Consumption? = null, val consumptionUpToReachableOffset: Consumption? = null, val remainingBudget: Consumption? = null, val reachableOffset: <Error class: unknown class>? = null)

The route summary contains the high-level route data.

TollgatePaymentType

value class TollgatePaymentType

Indicates a payment type accepted for a toll.

Waypoint

data class Waypoint(val id: RouteStopId, val place: <Error class: unknown class>, val navigableCoordinates: List<<Error class: unknown class>>, val routeOffset: <Error class: unknown class>, val roadSide: RoadSide? = null, val arrivalEnergy: <Error class: unknown class>? = null, val sourceType: RouteStop.SourceType = RouteStop.SourceType.UserDefined, val chargingInformation: <Error class: unknown class>? = null) : RouteStop

Represents a point that the route must visit between departure and destination.

Functions

angleTo

fun RoutePoint.angleTo(that: <Error class: unknown class>): <Error class: unknown class>

Calculates the angle (bearing) between this RoutePoint and the GeoPoint given as an argument.

distanceTo

fun RoutePoint.distanceTo(that: <Error class: unknown class>): <Error class: unknown class>

Calculates the geographic distance from this RoutePoint.coordinate to the GeoPoint given as an argument.

segmentForDistance

fun List<RoutePoint>.segmentForDistance(distanceAlongRoute: <Error class: unknown class>): Segment

Finds Segment at given distance along the route using binary search.