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.

DrivingSide

enum DrivingSide : Enum<DrivingSide>

Indicates driving side at the point of the maneuver.

ForkPoint

data class ForkPoint(val forkingRouteId: RouteId, val location: GeoPoint, val index: Int)

Represents information about a fork point.

PlanningReason

@JvmInline

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

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.

RouteId

@JvmInline

value class RouteId(val value: UniqueId = UniqueId())

A unique identifier of a Route.

RouteLeg

class RouteLeg(val points: List<GeoPoint>, val instructions: List<Instruction>, val summary: Summary, val mapReferences: MapReferences? = 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

class RoutePoint(val coordinate: GeoPoint, val routeOffset: Distance, val travelTime: Duration)

A GeoPoint on the route together with its distance offset along the route, estimated travel time, and remaining fuel or energy.

RouteStop

class RouteStop(val id: RouteStopId, val place: Place, val navigableCoordinates: List<GeoPoint>, val routeOffset: Distance, val roadSide: RoadSide? = null, val arrivalEnergy: Energy? = null, val chargingInformation: ChargingInformation? = null, val sourceType: RouteStop.SourceType = SourceType.UserDefined)

Represents a predetermined point on a route that is used as a reference point for navigation - Origin, Destination, Waypoint.

RouteStopId

@JvmInline

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

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

The route summary contains the high-level route data.

TollgatePaymentType

@JvmInline

value class TollgatePaymentType

Indicates a payment type accepted for a toll.

Functions

segmentForDistance

fun List<RoutePoint>.segmentForDistance(distanceAlongRoute: Distance): Segment

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