TomTom SDK for iOS Configuration

Configuration

public struct Configuration

The configuration to set up Navigation SDK for online mode.


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

The configuration to set up Navigation SDK for online mode.

Tip

At least one of the following properties must be specified:

apiKey
navigationTileStore

Tip: At least one of the following properties must be specified:

routePlanner
routeReplanner
routeReplanningEngine

Declaration

Swift

public init(
    locationProvider: LocationProvider,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner,
    apiKey: String? = nil,
    navigationTileStore: NavigationTileStore? = nil,
    dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = nil,
    mapMatchingEngine: MapMatchingEngine? = nil,
    horizonEngine: HorizonEngine? = nil,
    routeTrackingEngine: RouteTrackingEngine? = 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 default `LocationProvider` during navigation.
`routeReplanner`	Used while instantiating a default `RouteReplanningEngine`.
`apiKey`	API key needed for navigation.
`navigationTileStore`	Online data store to initialize navigation engines.
`dataStoreMaintenanceEngine`	Engine that updates the data store. If not provided, an instance created by `DefaultDataStoreMaintenanceEngineFactory` is used.
`mapMatchingEngine`	The default `MapMatchingEngine` during navigation. If not provided, an instance created by `TileStoreMapMatchingEngineFactory` is used.
`horizonEngine`	The default `HorizonEngine` during navigation.
`routeTrackingEngine`	The default `RouteTrackingEngine` during navigation. If not provided, an instance of `DefaultRouteTrackingEngine` is used.
`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.