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

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.

Note: The parameters departAt and arriveAt are not supported with the Orbis map.

Throws

IllegalArgumentException

if an invalid combination of options is used, such as specifying both departAt and arriveAt, or using chargingOptions with a non-electric vehicle.

Constructors

RoutePlanningOptions

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

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

Properties

alternativeRoutesOptions

val alternativeRoutesOptions: AlternativeRoutesOptions? = null

Options for calculating more than one route.

arrivalSidePreference

val arrivalSidePreference: ArrivalSidePreference

Specifies the road side on arrival preference for waypoints and destination.

val arriveAt: Date? = null

An arrival time for the route. Cannot be used together with departAt.

chargingOptions

val chargingOptions: ChargingOptions? = null

Additional options for electric vehicles to take charging into account.

val costModel: CostModel?

Options governing which streets to prefer.

val departAt: Date? = null

A departure time for the route.

guidanceOptions

val guidanceOptions: GuidanceOptions? = null

Properties for the generated instructions. Specify null for no instructions generation.

val itinerary: Itinerary

The list of route locations.

val mode: RouteInformationMode

Specifies how much guidance information (instructions and lane guidance) is returned with the route. Defaults to RouteInformationMode.Complete.

val queryOptions: QueryOptions? = null

Options regarding the way the request is sent to the server.

reconstructionMode

val reconstructionMode: ReconstructionMode?

Important: This is a Public Preview API. It may be changed or removed at any time.

routeLegOptions

val routeLegOptions: List<RouteLegOptions>

Options for each route leg, such as a polyline to follow.

val vehicle: Vehicle

The vehicle dimensions, restrictions and engine parameters. When guidanceOptions are given, the vehicle has to be of type VehicleType.Car, VehicleType.Motorcycle or VehicleType.Truck. Please use VehicleType.Car for VehicleType.Taxi.

waypointOptimization

val waypointOptimization: WaypointOptimization? = null

Specifies whether to optimize the order of waypoints, and if so, how.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String