com.tomtom.sdk.navigation:navigation-offline/com.tomtom.sdk.navigation.offline/Configuration

Configuration

data class Configuration(val context: Context, val locationProvider: LocationProvider, val ndsMapContext: NdsMapContext, val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, val routePlanner: RoutePlanner? = null, val routeReplanner: RouteReplanner? = null, val routeReplanningEngine: RouteReplanningEngine? = null, val replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(), val betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createDynamicGuidanceEngine( context, GuidanceEngineOptions() ), val horizonEngine: HorizonEngine? = null, val mapMatchingEngine: MapMatchingEngine? = null, val routeProjectionEngine: RouteProjectionEngine? = null, val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), val telemetry: Telemetry? = null, val safetyLocations: SafetyLocations? = null)

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

At least one of the following properties must be specified:

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

Constructors

Configuration

constructor(context: Context, locationProvider: LocationProvider, ndsMapContext: NdsMapContext, dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, routePlanner: RoutePlanner? = null, routeReplanner: RouteReplanner? = null, routeReplanningEngine: RouteReplanningEngine? = null, replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createDynamicGuidanceEngine( context, GuidanceEngineOptions() ), horizonEngine: HorizonEngine? = null, mapMatchingEngine: MapMatchingEngine? = null, routeProjectionEngine: RouteProjectionEngine? = null, routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(), routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), telemetry: Telemetry? = null, safetyLocations: SafetyLocations? = null)

Properties

arrivalDetectionEngine

val arrivalDetectionEngine: ArrivalDetectionEngine

The default ArrivalDetectionEngine during navigation. If it's not provided, an instance created by DefaultArrivalDetectionEngineFactory.create is used.

betterProposalAcceptanceMode

val betterProposalAcceptanceMode: BetterProposalAcceptanceMode

The default BetterProposalAcceptanceMode during navigation. If it's not provided, the mode is set to BetterProposalAcceptanceMode.Automatic.

context

val context: Context

Initializes Android dependencies.

dataStoreMaintenanceEngine

val dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null

Custom engine that updates the data store. If it is not provided, a default implementation of DataStoreMaintenanceEngine based on NdsMapContext.updater will be used. Note that if NdsMapContext.updater is null, the offline map data will not be updated.

deviationReplanningMode

val deviationReplanningMode: DeviationReplanningMode

Defines whether RouteReplanningEngine should try to replan the active RoutePlan after deviation. If it's not provided, the deviation replanning mode is set to DeviationReplanningMode.Automatic.

guidanceEngine

val guidanceEngine: GuidanceEngine

The default GuidanceEngine during navigation. If it's not provided, an instance created by GuidanceEngineFactory.createDynamicGuidanceEngine is used.

horizonEngine

val horizonEngine: HorizonEngine? = null

The default HorizonEngine during navigation. If it's not provided, an instance created by OfflineHorizonEngineFactory.create is used.

locationProvider

val locationProvider: LocationProvider

The default LocationProvider during navigation.

mapMatchingEngine

val mapMatchingEngine: MapMatchingEngine? = null

The default MapMatchingEngine during navigation. If it's not provided, an instance created by OfflineMapMatchingEngineFactory.create is used. If it's not provided, an instance created by OfflineLocationContextProviderEngineFactory.create is used.

ndsMapContext

val ndsMapContext: NdsMapContext

Wrapper over the NdsStore and NdsMapUpdater objects.

replanningRetryPolicy

val replanningRetryPolicy: ReplanningRetryPolicy

The default ReplanningRetryPolicy during navigation. If it's not provided, an instance created by ReplanningRetryPolicyFactory.create is used.

routePlanner

val routePlanner: RoutePlanner? = null

Used during instantiation of a default RouteReplanningEngine.

routeProgressEngine

val routeProgressEngine: RouteProgressEngine

The default RouteProgressEngine during navigation. If it's not provided, an instance created by RouteProgressEngineFactory.create is used.

routeProjectionEngine

val routeProjectionEngine: RouteProjectionEngine? = null

The default RouteProjectionEngine during navigation. If it's not provided, an instance created by OfflineRouteProjectionEngineFactory.create is used.

routeReplanner

val routeReplanner: RouteReplanner? = null

Used during instantiation of a default RouteReplanningEngine.

routeReplanningEngine

val routeReplanningEngine: RouteReplanningEngine? = null

The default RouteReplanningEngine during navigation.

routeTrackingEngine

val routeTrackingEngine: RouteTrackingEngine

The default RouteTrackingEngine during navigation. If it's not provided, an instance created by RouteTrackingEngineFactory.create is used.

safetyLocations

val safetyLocations: SafetyLocations? = null

Safety location data provider. It provides safety location data during navigation, which will be used by the horizon engine. If no safety location data provider is specified, there will be no safety location horizon elements in the horizon. If a custom horizon engine is specified in the configuration, this parameter will be ignored: the safety location data providers are injected into the custom horizon engine.

telemetry

val telemetry: Telemetry? = null

Used to send telemetry data.

vehicleProvider

val vehicleProvider: VehicleProvider

The default VehicleProvider during navigation. If it's not provided, an instance created by VehicleProviderFactory.create is used.