TomTom SDK for iOS Configuration

Configuration

public struct Configuration

The configuration used to set up Navigation SDK to work in hybrid mode. At least one of the following properties or combinations of properties must be specified:

onlineRoutePlanner and offlineRoutePlanner
routeReplanner
routeReplanningEngine

At least one of the following properties must be specified:

hybridNavigationDataStore
apiKey
navigationTileStore

At least one of the following properties must be specified:

hybridNavigationDataStore
ndsStore


                    
                    
                    init(locationProvider:apiKey:navigationTileStore:ndsMapContext:hybridNavigationDataStore:dataStoreMaintenanceEngine:dataSourceSelectionEngine:mapMatchingEngine:horizonEngine:routeTrackingEngine:onlineRoutePlanner:offlineRoutePlanner:routeReplanner:guidanceEngine:arrivalDetectionEngine:routeProgressEngine:routeReplanningEngine:routeReplanningRetryPolicy:routeDeviationReplanningRetryPolicy:betterProposalAcceptanceMode:deviationReplanningMode:vehicleProvider:safetyLocationsConfiguration:hazardsConfiguration:)

Creates a configuration to set up the Navigation SDK for hybrid mode.

Declaration

Swift

public init(
    locationProvider: LocationProvider,
    apiKey: String? = nil,
    navigationTileStore: NavigationTileStore? = nil,
    ndsMapContext: NDSMapContext? = nil,
    hybridNavigationDataStore: HybridNavigationDataStore? = nil,
    dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = nil,
    dataSourceSelectionEngine: DataSourceSelectionEngine? = nil,
    mapMatchingEngine: MapMatchingEngine? = nil,
    horizonEngine: HorizonEngine? = nil,
    routeTrackingEngine: RouteTrackingEngine? = nil,
    onlineRoutePlanner: TomTomSDKRoutePlanner.RoutePlanner? = nil,
    offlineRoutePlanner: TomTomSDKRoutePlanner.RoutePlanner? = nil,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner? = nil,
    guidanceEngine: GuidanceEngine = TomTomDynamicGuidanceEngine(),
    arrivalDetectionEngine: ArrivalDetectionEngine = TomTomArrivalDetectionEngine(),
    routeProgressEngine: RouteProgressEngine = StandaloneRouteProgressEngine(),
    routeReplanningEngine: RouteReplanningEngine = TomTomRouteReplanningEngine(),
    routeReplanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(),
    routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(),
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode = .automatic,
    deviationReplanningMode: DeviationReplanningMode = .automatic,
    vehicleProvider: VehicleProvider = VehicleProviderFactory.create(),
    safetyLocationsConfiguration: SafetyLocationsConfiguration? = nil,
    hazardsConfiguration: HazardsConfiguration? = nil
)

Parameters

`locationProvider`	The `LocationProvider` to be used during navigation.
`apiKey`	API key needed for navigation.
`navigationTileStore`	Online data store used during initialization of navigation engines.
`ndsMapContext`	Offline data store and its updater used during initialization of navigation engines.
`hybridNavigationDataStore`	Hybrid data store used during the initialization of navigation engines. If it is provided, there is no need for `navigationTileStore` and `ndsStore`.
`dataStoreMaintenanceEngine`	Engine that updates the data store. If not provided, an instance created by `DataStoreMaintenanceEngineFactory` is used.
`dataSourceSelectionEngine`	The [DataStoreSelectionEngine] that is to be used during navigation. If not provided, an instance of `DefaultDataStoreSelectionEngine` is used.
`mapMatchingEngine`	The default `MapMatchingEngine` during navigation. If not provided, an instance created by `HybridMapMatchingEngineFactory` is used.
`horizonEngine`	The default `HorizonEngine` during navigation.
`routeTrackingEngine`	The default `RouteTrackingEngine` during navigation. If not provided, an instance of `DefaultRouteTrackingEngine` is used.
`onlineRoutePlanner`	Used for online route replanning during instantiation of a default `RouteReplanner`.
`offlineRoutePlanner`	Used for offline route replanning while instantiating a default `RouteReplanner`.
`routeReplanner`	Used while instantiating a default `RouteReplanningEngine`.
`guidanceEngine`	The default `GuidanceEngine` during navigation. If not provided, an instance of `TomTomDynamicGuidanceEngine` is used.
`arrivalDetectionEngine`	The default `ArrivalDetectionEngine` during navigation. If not provided, an instance of `TomTomArrivalDetectionEngine` is used.
`routeProgressEngine`	The default [RouteProgressEngine] during navigation. If not provided, an instance of `StandaloneRouteProgressEngine` is used.
`routeReplanningEngine`	The default `RouteReplanningEngine` during navigation. If not provided, an instance of `TomTomRouteReplanningEngine` is used.
`routeReplanningRetryPolicy`	The default `ReplanningRetryPolicy` during navigation. If not provided, an instance of `DefaultReplanningRetryPolicy` is used.
`routeDeviationReplanningRetryPolicy`	The default `ReplanningRetryPolicy` during navigation. If not provided, an instance of `DefaultReplanningRetryPolicy` is used.
`betterProposalAcceptanceMode`	The default `BetterProposalAcceptanceMode` during navigation. If not provided, the mode is set to `BetterProposalAcceptanceMode.automatic`.
`deviationReplanningMode`	Defines whether `RouteReplanningEngine` should try replanning the active `RoutePlan` after deviation. If not provided, the deviation replanning mode is set to `DeviationReplanningMode.Automatic`.
`vehicleProvider`	The default `VehicleProvider` during navigation. If not provided, an instance created by `VehicleProviderFactory.create` is used.
`safetyLocationsConfiguration`	Configuration parameters for safety location data sources. If no configuration is specified, the horizon will not contain any `SafetyLocationElement`. This parameter is ignored if a custom `HorizonEngine` is specified in the configuration.
`hazardsConfiguration`	Configuration parameters for hazard data sources. If no configuration is specified, the horizon will not contain any `HazardElement`. This parameter is ignored if a custom `HorizonEngine` is specified in the configuration.