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 yet supported with the Orbis map.

itinerary

The list of route locations.

costModel

Options governing which streets to prefer.

departAt

A departure time for the route.

arriveAt

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

alternativeRoutesOptions

Options for calculating more than one route.

guidanceOptions

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

routeLegOptions

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

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.

chargingOptions

Additional options for electric vehicles to take charging into account.

queryOptions

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

waypointOptimization

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

mode

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

arrivalSidePreference

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

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

Constructors

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)