Configuration

public struct Configuration

The configuration used to set up Navigation SDK to work in off-road mode.

Lifecycle


                    
                    
                    init(locationProvider:routeReplanner:mapMatchingEngine:locationContextProviderEngine:routeTrackingEngine:routeProjectionEngine:guidanceEngine:arrivalDetectionEngine:routeProgressEngine:routeReplanningEngine:routeReplanningRetryPolicy:routeDeviationReplanningRetryPolicy:betterProposalAcceptanceMode:deviationReplanningMode:vehicleProvider:)

The configuration to set up Navigation SDK for off-road mode.

Declaration

Swift

public init(
    locationProvider: LocationProvider,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner = OffRoadRouteReplannerFactory.create(),
    mapMatchingEngine: MapMatchingEngine = OffRoadMapMatchingEngineFactory.create(),
    locationContextProviderEngine: LocationContextProviderEngine = OffRoadLocationContextProviderEngineFactory.create(),
    routeTrackingEngine: RouteTrackingEngine = OffRoadRouteTrackingEngineFactory.create(),
    routeProjectionEngine: RouteProjectionEngine = OffRoadRouteProjectionEngineFactory.create(),
    guidanceEngine: GuidanceEngine = OffRoadGuidanceEngineFactory.create(),
    arrivalDetectionEngine: ArrivalDetectionEngine = OffRoadArrivalDetectionEngineFactory.create(),
    routeProgressEngine: RouteProgressEngine = OffRoadRouteProgressEngineFactory.create(),
    routeReplanningEngine: RouteReplanningEngine = TomTomRouteReplanningEngine(),
    routeReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(),
    routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(forDeviation: true),
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode = .manual,
    deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.none,
    vehicleProvider: VehicleProvider = DefaultVehicleProvider()
)

Parameters

`locationProvider`	The default `LocationProvider` during navigation.
`routeReplanner`	Used while instantiating a default `RouteReplanningEngine`. If not provided, an instance created by `OffRoadRouteReplannerFactory` is used.
`mapMatchingEngine`	The default `MapMatchingEngine` during navigation. If not provided, an instance created by `OffRoadMapMatchingEngineFactory` is used.
`locationContextProviderEngine`	The default `LocationContextProviderEngine` during navigation. If not provided, an instance created by `OffRoadLocationContextProviderEngineFactory` is used.
`routeTrackingEngine`	The default `RouteTrackingEngine` during navigation. If not provided, an instance created by `OffRoadRouteTrackingEngineFactory` is used.
`routeProjectionEngine`	The default `RouteProjectionEngine` during navigation. If not provided, an instance created by `OffRoadRouteProjectionEngineFactory` is used.
`guidanceEngine`	The default `GuidanceEngine` during navigation. If not provided, an instance created by `OffRoadGuidanceEngineFactory` is used.
`arrivalDetectionEngine`	The default `ArrivalDetectionEngine` during navigation. If not provided, an instance created by `OffRoadArrivalDetectionEngineFactory` is used.
`routeProgressEngine`	The default `RouteProgressEngine` during navigation. If not provided, an instance created by `OffRoadRouteProgressEngineFactory` 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 `TomTomReplanningRetryPolicy` is used.
`routeDeviationReplanningRetryPolicy`	The default `ReplanningRetryPolicy` during navigation. If not provided, an instance of `TomTomReplanningRetryPolicy` is used.
`betterProposalAcceptanceMode`	The default `BetterProposalAcceptanceMode` during navigation. If not provided, the mode is set to `BetterProposalAcceptanceMode.Manual`.
`deviationReplanningMode`	Defines whether `RouteReplanningEngine` should try replanning the active `RoutePlan` after deviation. If not provided, the deviation replanning mode is set to `DeviationReplanningMode.None`.
`vehicleProvider`	The default `VehicleProvider` during navigation. If not provided, an instance of `DefaultVehicleProvider` is used.