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

Package-level declarations

Types

class BackToRouteOptions(val routePlanningOptions: RoutePlanningOptions, val originalRoute: Route, val deviationPoint: BackToRouteOptions.PointOnRoute, val currentLocation: GeoLocation)

Options for a back-to-route request, which are passed to one of the various route planners.

ChargingOptions

class ChargingOptions(val minChargeAtDestination: Energy, val minChargeAtChargingStops: Energy, val avoidChargingParks: List<UUID> = emptyList(), val chargingStopsStrategy: ChargingStopsStrategy = ChargingStopsStrategy.AutomaticFastest)

Represents the electric vehicle options that provide charging information.

ChargingStopsStrategy

@JvmInline

value class ChargingStopsStrategy

Specifies the charging stops strategy to be used by the Online Routing service.

Itinerary

data class Itinerary(val origin: ItineraryPoint, val destination: ItineraryPoint, val waypoints: List<ItineraryPoint> = emptyList())

The Itinerary represents a sequence of points that a route visits.

ItineraryPoint

class ItineraryPoint(val place: Place, val heading: Angle? = null)

Encapsulates Place with the additional information relevant for the route itinerary.

ItineraryPointId

@JvmInline

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

Represents a unique identifier of an itinerary point.

RangeCalculationOptions

class RangeCalculationOptions(val origin: ItineraryPoint, val budgets: Set<Budget>, val vehicle: Vehicle = Vehicle.Car(), val costModel: CostModel? = null, val departAt: Date? = null, val routeToInclude: Route? = null, val queryOptions: QueryOptions = QueryOptions())

Options for range calculation (see com.tomtom.sdk.routing.range.RangeCalculator), that is, determining the boundary of the area reachable from an initial vehicle position given an energy, fuel, time, or distance budget.

RouteInformationMode

@JvmInline

value class RouteInformationMode

The RouteInformationMode defines how much guidance information (instructions, lane guidance and junction views) is returned with the route.

RouteLegOptions

class RouteLegOptions(val supportingPoints: List<GeoPoint>, val chargingInformation: ChargingInformation? = null)

Options for a specific leg.

RoutePlanningOptions

class RoutePlanningOptions(val itinerary: Itinerary, val costModel: CostModel? = CostModel(), val departAt: Date? = null, val arriveAt: Date? = null, val alternativeRoutesOptions: AlternativeRoutesOptions? = null, val guidanceOptions: GuidanceOptions? = null, val routeLegOptions: List<RouteLegOptions> = emptyList(), val vehicle: Vehicle = Vehicle.Car(), val chargingOptions: ChargingOptions? = null, val queryOptions: QueryOptions? = null, val waypointOptimization: WaypointOptimization? = null, val mode: RouteInformationMode = RouteInformationMode.Complete, val arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide)

Options for planning routes, which are passed to one of the various route planners.

WaypointType

class WaypointType

Defines the type of ItineraryPoint.

Functions

copy

fun RangeCalculationOptions.copy(origin: ItineraryPoint = this.origin, budgets: Set<Budget> = this.budgets, vehicle: Vehicle = this.vehicle, costModel: CostModel? = this.costModel, departAt: Date? = this.departAt, routeToInclude: Route? = this.routeToInclude, queryOptions: QueryOptions = this.queryOptions): RangeCalculationOptions

Copies this object while allowing to change some properties.