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.

Note

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

Throws

RoutingOptionsError if invalid routing options provided.

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 `TomTomSDKCommon/VehicleType/car`, `TomTomSDKCommonVehicleType/motorcycle` or `TomTomSDKCommon/VehicleType/truck`. Please use `TomTomSDKCommon/VehicleType/car` for `TomTomSDKCommon/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.
`arrivalSidePreference`	Defines road side on arrival preference for waypoints and destination.
`reconstructionMode`	Defines the reconstruction mode used for route reconstruction.


                    
                    
                    init(itinerary:routeType:considerTraffic:avoidOptions: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.

Note

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

Throws

RoutingOptionsError if invalid routing options provided.

Important

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

Declaration

Swift

public init
    (
        itinerary: Itinerary,
        routeType: RouteType? = nil,
        considerTraffic: ConsiderTraffic? = nil,
        avoidOptions: AvoidOptions? = 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.
`routeType`	General strategy for selecting roads during route calculation.
`considerTraffic`	Use live traffic in the route calculation.
`avoidOptions`	Avoidance criteria.
`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.
`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.
`arrivalSidePreference`	Defines road side on arrival preference for waypoints and destination.
`reconstructionMode`	Defines the reconstruction mode used for route reconstruction.

itinerary
The list of route locations.
Declaration
Swift

public var itinerary: Itinerary
alternativeRoutesOptions
Options for calculating more than one route.
Declaration
Swift

public var alternativeRoutesOptions: AlternativeRoutesOptions?
routeLegOptions
Options for each route leg, such as a polyline to follow.
Declaration
Swift

public var routeLegOptions: [RouteLegOptions]
guidanceOptions
Properties for the generated instructions. Instructions will not be generated if the options are not set.
Declaration
Swift

public var guidanceOptions: GuidanceOptions?
departAt
A departure time for the route. Cannot be used together with arriveAt.

Note
This option is not supported with the Orbis map.
Declaration
Swift

public var departAt: Date?
arriveAt
An arrival time for the route. Cannot be used together with departAt.

Note
This option is not supported with the Orbis map.
Declaration
Swift

public var arriveAt: Date?
vehicle
The vehicle dimensions, restrictions and engine parameters.

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

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

public var vehicle: any Vehicle
chargingOptions
Additional options for electric vehicles to take charging into account.

Note
If provided, the vehicle must be Bus, Car, Motorcycle or Van.
Declaration
Swift

public var chargingOptions: ChargingOptions?
queryOptions
Options regarding the way the request is sent to the server.
Declaration
Swift

public var queryOptions: QueryOptions?
waypointOptimization
The way of optimizing the order of waypoints
Declaration
Swift

public var waypointOptimization: WaypointOptimization?
mode
Defines how much guidance information (instructions and lane guidance) is returned with the route.
Declaration
Swift

public var mode: RouteInformationMode
reconstructionMode
Defines the reconstruction mode used for route reconstruction.

Note
This option is not supported with the Orbis map.

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

public var reconstructionMode: ReconstructionMode?
arrivalSidePreference
Specifies road side on arrival preference for waypoints and destination.
Declaration
Swift

public var arrivalSidePreference: ArrivalSidePreference
routeType
Defines general strategy for selecting roads during route calculation.

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

public private(set) var routeType: RouteType? { get }
considerTraffic
Defines if live traffic should be used in route calculation.

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

public private(set) var considerTraffic: ConsiderTraffic? { get }
avoidOptions
Specifies avoidance criteria.

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

public private(set) var avoidOptions: AvoidOptions? { get }
costModel
Options governing which paths to prefer.
Declaration
Swift

public var costModel: CostModel? { get set }