Package-level declarations

Types

Link copied to clipboard
value class ComputedAs

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.

Link copied to clipboard
abstract class Consumption

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

Link copied to clipboard
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.UserDefined, val chargingInformation: ChargingInformation? = null) : RouteStop

Represents the destination of the route.

Link copied to clipboard

Indicates driving side at the point of the maneuver.

Link copied to clipboard
data class ForkPoint(val forkingRouteId: RouteId, val location: GeoPoint)

Represents information about the fork point.

Link copied to clipboard
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.UserDefined, val chargingInformation: ChargingInformation? = null) : RouteStop

Represents the origin of the route.

Link copied to clipboard

Represents the planning reason returned from the route planner.

Link copied to clipboard

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

Link copied to clipboard
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: Distance = 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.

Link copied to clipboard
value class RouteId(val value: UniqueId = UniqueId())

A unique identifier of a Route.

Link copied to clipboard
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. Contains a list of Instructions for all the maneuvers along the route leg.

Link copied to clipboard
data class RouteModificationHistory(val creation: RouteTimestamp, val lastUpdate: RouteTimestamp = creation)

Information about the route creation and the last update.

Link copied to clipboard
data class RoutePoint(val coordinate: GeoPoint, val routeOffset: Distance, val travelTime: Duration)

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

Link copied to clipboard
interface RouteStop

Represents a point that the route must visit.

Link copied to clipboard
value class RouteStopId(val value: UUID = UUID.randomUUID())

A unique identifier, used for matching RouteStop with ItineraryPoint.

Link copied to clipboard
data class RouteTimestamp(val timestampInMillis: Long, val timeWithZone: Calendar)

Information about route creation or modification time.

Link copied to clipboard
class Segment(val start: RoutePoint, val end: RoutePoint)

Represents a line between two RoutePoint.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.UserDefined, val chargingInformation: ChargingInformation? = null) : RouteStop

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

Functions

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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