TomTom SDK for iOS RouteTrackingEngine

RouteTrackingEngine

public protocol RouteTrackingEngine : ManageableEngine

Responsible for detecting whether the Routes are being followed or deviated from.

Important

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


                    
                    
                    obtainTrackingStates(navigationSnapshot:)

Determines the RouteTrackingState of the tracked Route.

Throws

The method can throw different types of errors: RouteTrackingEngineError if trip snapshot is missing in navigation snapshot. DistanceAlongRouteCalculatorError if calculation fails. NavigationProcessingError if route is missing in navigation snapshot.

Declaration

Swift

func obtainTrackingStates(navigationSnapshot: NavigationSnapshot) throws -> RouteTrackingState

Parameters


                                navigationSnapshot

The NavigationSnapshot used to determine if the Route is currently followed or deviated from.

Return Value

A RouteTrackingState object for tracked routes.