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

Configuration

data class Configuration(val context: Context, val locationProvider: LocationProvider, 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 = OffRoadGuidanceEngineFactory.create(), val mapMatchingEngine: MapMatchingEngine = OffRoadMapMatchingEngineFactory.create(), val routeProjectionEngine: RouteProjectionEngine = OffRoadRouteProjectionEngineFactory.create(), val routeTrackingEngine: RouteTrackingEngine = OffRoadRouteTrackingEngineFactory.create(), val routeProgressEngine: RouteProgressEngine = OffRoadRouteProgressEngineFactory.create(), val arrivalDetectionEngine: ArrivalDetectionEngine = OffRoadArrivalDetectionEngineFactory.create(), val vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), val telemetry: Telemetry? = null)

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

Constructors

Link copied to clipboard
constructor(context: Context, locationProvider: LocationProvider, routeReplanner: RouteReplanner? = null, routeReplanningEngine: RouteReplanningEngine? = null, replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, guidanceEngine: GuidanceEngine = OffRoadGuidanceEngineFactory.create(), mapMatchingEngine: MapMatchingEngine = OffRoadMapMatchingEngineFactory.create(), routeProjectionEngine: RouteProjectionEngine = OffRoadRouteProjectionEngineFactory.create(), routeTrackingEngine: RouteTrackingEngine = OffRoadRouteTrackingEngineFactory.create(), routeProgressEngine: RouteProgressEngine = OffRoadRouteProgressEngineFactory.create(), arrivalDetectionEngine: ArrivalDetectionEngine = OffRoadArrivalDetectionEngineFactory.create(), vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), telemetry: Telemetry? = null)

Properties

Link copied to clipboard
val arrivalDetectionEngine: ArrivalDetectionEngine

The default ArrivalDetectionEngine during navigation. If it's not provided, an instance of off-road arrival detection engine is used.

Link copied to clipboard
Link copied to clipboard
val context: Context

Initializes Android dependencies.

Link copied to clipboard
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.

Link copied to clipboard
val guidanceEngine: GuidanceEngine

The default GuidanceEngine during navigation. If it's not provided, an instance of off-road guidance engine is used.

Link copied to clipboard
val locationProvider: LocationProvider

The default LocationProvider during navigation.

Link copied to clipboard
val mapMatchingEngine: MapMatchingEngine

The default MapMatchingEngine during navigation. If it's not provided, an instance of off-road map matching engine is used.

Link copied to clipboard
val replanningRetryPolicy: ReplanningRetryPolicy

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

Link copied to clipboard
val routeProgressEngine: RouteProgressEngine

The default RouteProgressEngine during navigation. If it's not provided, an instance of off-road route progress engine is used.

Link copied to clipboard
val routeProjectionEngine: RouteProjectionEngine

The default RouteProjectionEngine during navigation. If it's not provided, an instance of off-road route projection engine is used.

Link copied to clipboard
val routeReplanner: RouteReplanner? = null

Used during instantiation of a default RouteReplanningEngine. If it's not provided, an instance of off-road route replanner is used.

Link copied to clipboard
val routeReplanningEngine: RouteReplanningEngine? = null

The default RouteReplanningEngine during navigation.

Link copied to clipboard
val routeTrackingEngine: RouteTrackingEngine

The default RouteTrackingEngine during navigation. If it's not provided, an instance of off-road route tracking engine is used.

Link copied to clipboard
val telemetry: Telemetry? = null

Used to send telemetry data.

Link copied to clipboard
val vehicleProvider: VehicleProvider

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