NavigationConfiguration

public struct NavigationConfiguration : NavigationConfigurable

A NavigationConfiguration that helps to construct NavigationConfiguration.

Important

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

Lifecycle


                    
                    
                    init(apiKey:locationProvider:routeReplanner:apiPath:dataSourceSelectionEngine:mapMatchingEngine:routeProgressProviderEngine:guidanceEngine:routeTrackingEngine:arrivalDetectionEngine:locationContextProviderEngine:routeReplanningEngine:routeProjectionEngine:horizonEngine:routeReplanningRetryPolicy:routeDeviationReplanningRetryPolicy:betterProposalAcceptanceMode:deviationReplanningMode:vehicleProvider:)

Creates a configuration with the specified navigation key, location provider and route replanner.

Tip

Default tables.

New navigation processing | Parameter | Type | |—————————-|————————————————————| | mapMatching | Internal type. | | routeProgress | StandaloneRouteProgressEngine | | guidance | TomTomGuidanceEngine | | routeTracking | Internal type. | | arrivalDetection | TomTomArrivalDetectionEngine | | locationContextDetection | Internal type. | | routeReplanning | TomTomRouteReplanningEngine |
Primary navigation processing | Parameter | Type | |—————————-|————————————–| | mapMatching | DefaultMapMatchingEngine | | routeProgress | NavKitRouteProgressProviderEngine | | guidance | TomTomGuidanceEngine | | routeTracking | NavKitRouteTrackingEngine | | arrivalDetection | TomTomArrivalDetectionEngine | | locationContextDetection | NavKitLocationContextEngine | | routeReplanning | TomTomRouteReplanningEngine |

Declaration

Swift

public init(
    apiKey: String,
    locationProvider: LocationProvider,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner,
    apiPath: URLComponents? = nil,
    dataSourceSelectionEngine: DataSourceSelectionEngine? = nil,
    mapMatchingEngine: MapMatchingEngine? = nil,
    routeProgressProviderEngine: RouteProgressProviderEngine? = nil,
    guidanceEngine: GuidanceEngine? = nil,
    routeTrackingEngine: RouteTrackingEngine? = nil,
    arrivalDetectionEngine: ArrivalDetectionEngine? = nil,
    locationContextProviderEngine: LocationContextProviderEngine? = nil,
    routeReplanningEngine: RouteReplanningEngine? = nil,
    routeProjectionEngine: RouteProjectionEngine? = nil,
    horizonEngine: HorizonEngine? = nil,
    routeReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(),
    routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(forDeviation: true),
    betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.default,
    deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.default,
    vehicleProvider: VehicleProvider = DefaultVehicleProvider()
)

Parameters

`apiKey`	API key used to access the navigation services.
`locationProvider`	`LocationProvider` that will be used by navigation
`routeReplanner`	Route replanner to be used when replanning.
`apiPath`	Specifies a custom api path `URLComponents` that will be used by navigation.
`dataSourceSelectionEngine`	Specifies a custom `DataSourceSelectionEngine` that will be used by navigation.
`mapMatchingEngine`	Specifies a custom `MapMatchingEngine` that will be used by navigation.
`routeProgressProviderEngine`	Specifies a custom `RouteProgressProviderEngine` that will be used by navigation.
`guidanceEngine`	Specifies a custom `GuidanceEngine` that will be used by navigation.
`routeTrackingEngine`	Specifies a custom `RouteTrackingEngine` that will be used by navigation.
`arrivalDetectionEngine`	Specifies a custom `ArrivalDetectionEngine` that will be used by navigation.
`locationContextProviderEngine`	Specifies a custom `LocationContextProviderEngine` that will be used by navigation.
`routeReplanningEngine`	Specifies a custom `RouteReplanningEngine` that will be used by navigation.
`routeProjectionEngine`	Specifies a custom `RouteProjectionEngine` that will be used by navigation.
`horizonEngine`	Specifies a custom `HorizonEngine` that will be used by navigation.
`routeReplanningRetryPolicy`	Specifies a custom `ReplanningRetryPolicy` to be used by navigation to decide if a failed replan should be retried.
`routeDeviationReplanningRetryPolicy`	Specifies a custom `ReplanningRetryPolicy` to be used by navigation to decide if a failed deviation replan should be retried.
`betterProposalAcceptanceMode`	Specifies a custom `BetterProposalAcceptanceMode` that will be used by navigation.
`deviationReplanningMode`	Specifies if `RouteReplanningEngine` should try to replan a `RoutePlan` after deviation.
`vehicleProvider`	`VehicleProvider` that will be used by navigation.

Public

locationProvider
LocationProvider that will be used by navigation.
Declaration
Swift

public let locationProvider: LocationProvider
routeReplanner
Route replanner to be used when replanning.
Declaration
Swift

public let routeReplanner: TomTomSDKRouteReplanner.RouteReplanner
routeReplanningRetryPolicy
Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed replan should be retried.
Declaration
Swift

public let routeReplanningRetryPolicy: ReplanningRetryPolicy
routeDeviationReplanningRetryPolicy
Specifies a custom ReplanningRetryPolicy to be used by navigation to decide if a failed deviation replan should be retried.
Declaration
Swift

public let routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy
betterProposalAcceptanceMode
Specifies a custom BetterProposalAcceptanceMode that will be used by navigation.
Declaration
Swift

public let betterProposalAcceptanceMode: BetterProposalAcceptanceMode
deviationReplanningMode
Specifies if RouteReplanningEngine should try to replan a RoutePlan after deviation. Flag specifying if automatic route replanning after deviation should be enabled.
Declaration
Swift

public let deviationReplanningMode: DeviationReplanningMode
vehicleProvider
VehicleProvider that will be used by navigation.
Declaration
Swift

public let vehicleProvider: VehicleProvider
parameters
Specifies a custom api path URLComponents that will be used by navigation. Configuration parameters for the navigation service.
Declaration
Swift

public let parameters: URLComponents?
navigationEngines
The NavigationEngines protocol defines all engines that can be used by the TomTomSDKNavigation module.
Declaration
Swift

public let navigationEngines: NavigationEngines