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

if an invalid combination of options is used. Invalid combinations are:

Constructors

Link copied to clipboard
constructor(itinerary: Itinerary, routeType: RouteType? = null, considerTraffic: ConsiderTraffic? = ConsiderTraffic.Yes, avoidOptions: AvoidOptions? = null, 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)

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

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)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Options for calculating more than one route.

Link copied to clipboard

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

Link copied to clipboard
val arriveAt: Date? = null

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

Link copied to clipboard

Avoidance criteria.

Link copied to clipboard

Additional options for electric vehicles to take charging into account.

Link copied to clipboard

Use live traffic in the route calculation.

Link copied to clipboard

Options governing which streets to prefer.

Link copied to clipboard
val departAt: Date? = null

A departure time for the route.

Link copied to clipboard

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

Link copied to clipboard

The list of route locations.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

General strategy for selecting roads during route calculation.

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String