TomTom SDK for iOS Configuration

Configuration

public struct Configuration

The configuration used to set up Navigation SDK to work in offline mode.

This configuration offers two setup options:

Basic configuration: Sets up the Navigation SDK with essential navigation components.
Advanced configuration: Includes essential navigation and additional components for advanced use cases. The advanced configuration allows for extensive customization of individual navigation engines and components. Using the advanced configuration and setting default engines is equivalent to using the basic constructor.


                    
                    
                    init(ndsStore:locationProvider:routePlanner:vehicleProvider:betterProposalAcceptanceMode:deviationReplanningMode:)

Simple configuration used to set up Navigation SDK to work in offline mode.

Declaration

Swift

public init(
    ndsStore: NDSStore,
    locationProvider: LocationProvider,
    routePlanner: RoutePlanner,
    vehicleProvider: VehicleProvider = VehicleProviderFactory.create(),
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode = .automatic,
    deviationReplanningMode: DeviationReplanningMode = .automatic
)

Parameters

`ndsStore`	The `NDSStore` object that is used to provide offline map data to the navigation engines.
`locationProvider`	Informs navigation of location updates.
`routePlanner`	Used by `RouteReplanningEngine` to update the active `RoutePlan` or to replan after a deviation. If a custom `RouteReplanningEngine` is specified in the configuration, this parameter will be ignored.
`vehicleProvider`	Enables navigation to listen to the changes of the vehicle state. Information from `vehicle` is leveraged by the `HorizonEngine` to provide the relevant virtual horizon. Additionally, it is used as a request parameter for route replannings during the navigation session. Notably, it supersedes any vehicle information specified in the `routePlanningOptions` whether at the navigation start, or during any subsequent automatic or manual route replanning events. If it’s not provided, an instance created by `VehicleProviderFactory/create` is used.
`betterProposalAcceptanceMode`	Specifies how better route proposals are applied during navigation. If it’s not provided, the mode is set to `automatic`.
`deviationReplanningMode`	Defines whether navigation should try to replan the active `RoutePlan` after deviation. If not provided, the deviation replanning mode is set to `automatic`.


                    
                    
                    init(ndsMapContext:locationProvider:routePlanner:vehicleProvider:betterProposalAcceptanceMode:deviationReplanningMode:replanningRetryPolicy:routeReplanningEngine:dataStoreMaintenanceEngine:guidanceEngine:horizonEngine:mapMatchingEngine:routeTrackingEngine:routeProgressEngine:arrivalDetectionEngine:safetyLocationsConfiguration:hazardsConfiguration:)

The configuration to set up Navigation SDK for offline mode.

Important

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

Declaration

Swift

public init(
    ndsMapContext: NDSMapContext,
    locationProvider: LocationProvider,
    routePlanner: RoutePlanner,
    vehicleProvider: VehicleProvider = VehicleProviderFactory.create(),
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode = .automatic,
    deviationReplanningMode: DeviationReplanningMode = .automatic,
    replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(),
    routeReplanningEngine: RouteReplanningEngine = TomTomRouteReplanningEngine(),
    dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = nil,
    guidanceEngine: GuidanceEngine = TomTomDynamicGuidanceEngine(),
    horizonEngine: HorizonEngine? = nil,
    mapMatchingEngine: MapMatchingEngine? = nil,
    routeTrackingEngine: RouteTrackingEngine? = nil,
    routeProgressEngine: RouteProgressEngine = StandaloneRouteProgressEngine(),
    arrivalDetectionEngine: ArrivalDetectionEngine = TomTomArrivalDetectionEngine(),
    safetyLocationsConfiguration: SafetyLocationsConfiguration? = nil,
    hazardsConfiguration: HazardsConfiguration? = nil
)

Parameters

`ndsMapContext`	Offline data store and its updater used during initialization of navigation engines. It contains the `NdsStore` object that is used to provide offline map data to the navigation engines. And `NdsMapUpdater` implementation that will update the given `NdsStore` with the areas of interest (for example: current position) that navigation provides.
`locationProvider`	Informs navigation of location updates.
`routePlanner`	Used by `RouteReplanningEngine` to update the active `RoutePlan` or to replan after a deviation. If a custom `RouteReplanningEngine` is specified in the configuration, this parameter will be ignored.
`vehicleProvider`	Enables navigation to listen to the changes of the vehicle state. Information from `vehicle` is leveraged by the `HorizonEngine` to provide the relevant virtual horizon. Additionally, it is used as a request parameter for route replannings during the navigation session. Notably, it supersedes any vehicle information specified in the `routePlanningOptions` whether at the navigation start, or during any subsequent automatic or manual route replanning events. If it’s not provided, an instance created by `VehicleProviderFactory/create` is used.
`betterProposalAcceptanceMode`	Specifies how better route proposals are applied during navigation. If it’s not provided, the mode is set to `automatic`.
`deviationReplanningMode`	Defines whether navigation should try to replan the active `RoutePlan` after deviation. If not provided, the deviation replanning mode is set to `automatic`.
`replanningRetryPolicy`	Specifies how to handle requests which failed during replanning of a Route. If it’s not provided, an instance of `ReplanningRetryPolicyFactory/create` is used.
`routeReplanningEngine`	Engine responsible for replanning a route during navigation. If it’s not provided, an instance of `RouteReplanningEngineFactory/create` is used, with `RouteReplanner` created from `OfflineRouteReplannerFactory/create`.
`dataStoreMaintenanceEngine`	Engine responsible for instantiating updates of the data store. If it’s not provided, an instance created by `DefaultDataStoreMaintenanceEngineFactory/create` is used.
`guidanceEngine`	Engine responsible for generating guidance instructions of the upcoming road maneuvers. If it’s not provided, an instance created by `GuidanceEngineFactory/create` is used.
`horizonEngine`	Engine responsible for providing location context data extending beyond the driver’s visible horizon. If it’s not provided, an instance created by `OfflineHorizonEngineFactory/create` is used.
`mapMatchingEngine`	Engine responsible for improving position accuracy by attempting to match it to the map or the route. If it’s not provided, an instance created by `OfflineMapMatchingEngineFactory/create` is used.
`routeTrackingEngine`	Engine responsible for detecting whether the routes are being followed. If not provided the default implementation of `RouteTrackingEngine` is used.
`routeProgressEngine`	Engine responsible for determining the progress made along the current route. If it’s not provided, an instance created by `RouteProgressEngineFactory/create` is used.
`arrivalDetectionEngine`	Engine responsible for deciding if the route’s destination has been reached. If it’s not provided, an instance created by `ArrivalDetectionEngineFactory/create` is used.
`safetyLocationsConfiguration`	Configuration parameters for safety location data sources. If no configuration is specified, the horizon will not contain any `SafetyLocationElement`. If a custom `HorizonEngine` is specified in the configuration, this parameter will be ignored.
`hazardsConfiguration`	Configuration parameters for hazard data sources. If no configuration is specified, the horizon will not contain any `HazardElement`. If a custom `HorizonEngine` is specified in the configuration, this parameter will be ignored.