TomTom SDK for iOS RoutePlanningOptions

RoutePlanningOptions

public struct RoutePlanningOptions : RoutingOptionsWithItinerary

Options for route planning.


                    
                    
                    init(itinerary:costModel:alternativeRoutesOptions:routeLegOptions:guidanceOptions:departAt:arriveAt:vehicle:chargingOptions:queryOptions:waypointOptimization:mode:arrivalSidePreference:reconstructionMode:)

Creates a new RoutePlanningOptions instance.

Note

If chargingOptions are provided, the vehicle must be Bus, Car, Motorcycle or Van.

Throws

RoutingOptionsError 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 routeLegOptions where any leg has only 1 supporting point
using arriveAt with AlternativeRoutesOptions.minDeviationTime or `AlternativeRoutesOptions.minDeviationDistance
using AlternativeRoutesOptions.minDeviationTime or AlternativeRoutesOptions.minDeviationDistance with no routeLegOptions or less than two supporting points in any leg
using motorized vehicle with combustion and electric engines at the same time
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
using reconstructionMode set to ReconstructionMode.update or ReconstructionMode.route with an itinerary in which the origin and destination coordinates do not match the first and last point of the supporting polyline respectively.

Important

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

Declaration

Swift

public init
    (
        itinerary: Itinerary,
        costModel: CostModel? = nil,
        alternativeRoutesOptions: AlternativeRoutesOptions? = nil,
        routeLegOptions: [RouteLegOptions] = [],
        guidanceOptions: GuidanceOptions? = nil,
        departAt: Date? = nil,
        arriveAt: Date? = nil,
        vehicle: any Vehicle = Car(),
        chargingOptions: ChargingOptions? = nil,
        queryOptions: QueryOptions? = nil,
        waypointOptimization: WaypointOptimization? = nil,
        mode: RouteInformationMode = .complete,
        arrivalSidePreference: ArrivalSidePreference = .anySide,
        reconstructionMode: ReconstructionMode? = nil
    ) throws

Parameters

`itinerary`	The list of route locations.
`costModel`	Options governing which paths to prefer.
`alternativeRoutesOptions`	Options for calculating more than one route.
`routeLegOptions`	Options for each route leg, such as a polyline to follow.
`guidanceOptions`	Properties for the generated instructions. Instructions will not be generated if the options are not set.
`departAt`	A departure time for the route. Cannot be used together with arriveAt.
`arriveAt`	An arrival time for the route. Cannot be used together with departAt.
`vehicle`	The vehicle dimensions, restrictions and engine parameters. If `guidanceOptions` are provided, the vehicle must 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`	Defines how to optimize the order of waypoints.
`mode`	Defines how much guidance information (instructions and land guidance) is returned with the route. Defaults to `RouteInformationMode.complete`.
`arrivalSidePreference`	Defines road side on arrival preference for waypoints and destination.
`reconstructionMode`	Defines the reconstruction mode used for route reconstruction. If the value is nil and at least one `routeLegOptions` has supporting points it will be defaulted to `ReconstructionMode.track`. If the value is `ReconstructionMode.route` or `ReconstructionMode.update` the `itinerary.origin.heading` parameter is ignored.


                    
                    
                    init(itinerary:routeType:considerTraffic:avoidOptions:alternativeRoutesOptions:routeLegOptions:guidanceOptions:departAt:arriveAt:vehicle:chargingOptions:queryOptions:waypointOptimization:mode:arrivalSidePreference:reconstructionMode:)