common:route/com.tomtom.sdk.route

Package-level declarations

Types

data class Announcement(val id: UniqueId = UniqueId(), val point: GeoPoint? = null, val distance: Distance, val type: String, val verbalMessage: String = "", val verbalMessagePhonetics: Phonetics? = null)

Fine-grained announcement points, each with its own message, location and distance to the instruction point.

Budget

abstract class Budget

Either of Budget.Fuel, Budget.Energy, Budget.Time or Budget.Distance.

Consumption

abstract class Consumption

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

Destination

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

Represents the destination of the route.

DrivingSide

enum DrivingSide : Enum<DrivingSide>

Indicates driving side at the point of the maneuver.

ForkPoint

class ForkPoint(val forkingRouteId: RouteId, val location: GeoPoint)

Represents information about the fork point.

Origin

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

Represents the origin of the route.

Phonetics

data class Phonetics(val street: String = "", val streetLanguageCode: String = "", val roadNumbers: List<String> = emptyList(), val roadNumbersLanguageCodes: List<String> = emptyList(), val signPostText: String = "", val signPostTextLanguageCode: String = "")

Phonetic strings of all of the readable Instruction properties.

PhoneticString

data class PhoneticString(val value: String, val language: String, val alphabet: String)

Represents a phonetic string.

Range

data class Range(val origin: GeoPoint, val polygons: Map<Budget, List<GeoPoint>>)

The range class contains reachability polygons for remaining energy budgets, calculated around an origin point.

RoadInformation

data class RoadInformation(val roadName: TextWithPhonetics?, val roadNumbers: List<TextWithPhonetics>, val roadShields: List<RoadShield>, val roadTypes: Set<RoadType> = emptySet())

Road information at a given point on a Route.

RoadShield

data class RoadShield(val fullRoadNumber: String, val shieldContent: String = "", val affixes: List<String> = emptyList(), val stateCode: String = "", val countryCode: String = "", val languageCode: String = "", val reference: String = "")

Represents a road shield.

RoadSide

enum RoadSide : Enum<RoadSide>

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

RoadType

@JvmInline

value class RoadType

Indicates a road type.

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 routeCoordinates: List<RouteCoordinate> = emptyList(), val forkPoints: List<ForkPoint> = emptyList(), val incrementEndOffset: Distance = Distance.ZERO)

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

RouteCoordinate

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

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

RouteId

@JvmInline

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

A unique identifier of a Route.

RouteLeg

data 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.

RouteModificationHistory

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

Information about the route creation and the last update.

RouteStop

interface RouteStop

Represents a point that the route must visit.

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: RouteCoordinate, val end: RouteCoordinate)

Represents a line between two RouteCoordinate.

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: 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.

TextWithPhonetics

data class TextWithPhonetics(val plainText: String, val plainTextLanguage: String = "", val phoneticString: PhoneticString? = null)

Represents a localized string with optional phonetics information.

Waypoint

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

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

Functions

angleTo

fun RouteCoordinate.angleTo(that: GeoPoint): Double

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

distanceTo

fun RouteCoordinate.distanceTo(that: GeoPoint): Distance

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

segmentForDistance

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

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