TomTom SDK for iOS OffRoadArrivalDetectionEngineFactory

OffRoadArrivalDetectionEngineFactory

public enum OffRoadArrivalDetectionEngineFactory

Factory for creating an off-road ArrivalDetectionEngine instance.

Off-road arrival detection engine detects when the driver has reached their final destination during off-road navigation.

Example of creating an OffRoadArrivalDetectionEngine with the default value for destinationArrivalDistanceThreshold:

let offRoadArrivalDetectionEngine = OffRoadArrivalDetectionEngineFactory.create()

Example of creating an OffRoadArrivalDetectionEngine with a specific value for destinationArrivalDistanceThreshold:

let offRoadArrivalDetectionEngine = OffRoadArrivalDetectionEngineFactory.create(destinationArrivalDistanceThreshold: .tt.meters(5))

To create a default off-road Navigation, check the OffRoadTomTomNavigationFactory class.

Important

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

Defaults
Provides default values for creating an OffRoadArrivalDetectionEngine.
See more
Declaration
Swift

public enum Defaults


                    
                    
                    create(destinationArrivalDistanceThreshold:)

Creates an instance of ArrivalDetectionEngine.

This engine handles the arrival detection for off-road navigation. Off-road navigation and traditional navigation handle arrival differently. Off-road navigation uses only distance to check if the user has arrived at the destination.

Declaration

Swift

public static func create(
    destinationArrivalDistanceThreshold: Measurement<UnitLength> = Defaults
        .destinationArrivalDistanceThreshold
)
    -> ArrivalDetectionEngine

Parameters


                                destinationArrivalDistanceThreshold

The distance threshold that triggers the destination arrival status. If it is not set, the Defaults.destinationArrivalDistanceThreshold value is used.

Return Value

An instance of ArrivalDetectionEngine.