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.

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

using non-zero pauseTime for the origin or destination
using departAt and arriveAt at the same time.
using alternativeRoutesOptions with no routeLegOptions or no supporting points in the first leg
using arriveAt with alternativeRoutesOptions.minDeviationTime or alternativeRoutesOptions.minDeviationDistance
using chargingOptions with

a non-motorized vehicle
a motorized vehicle without an electric engine
an electric vehicle without a charge level
chargingOptions.minChargeAtDestination greater than chargeLevel.maxCharge
chargingOptions.minChargeAtChargingStops greater than chargeLevel.maxCharge
waypointOptimization other than WaypointOptimization.None
costModel.routeType other than RouteType.Fast
costModel.considerTraffic other than ConsiderTraffic.Yes; this limitation is applicable for the Orbis map only

using path alternatives with waypoint optimization
using route- and leg-level routeType together
specifying different number of route leg options than the number of route legs based on the provided itinerary
using guidanceOptions with a vehicle other than VehicleType.Car, VehicleType.Motorcycle or VehicleType.Truck

Constructors

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)