TomTom SDK for iOS RouteProgressEngine

RouteProgressEngine

public protocol RouteProgressEngine : ManageableEngine

The RouteProgressEngine protocol provides functionality related to the calculation of progress along the route.

Important

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


                    
                    
                    calculateProgress(navigationSnapshot:)

Calculates progress along the route which can base on passed NavigationSnapshot.

Throws

NavigationProcessingError.routeDataMissing if there is no active route. RouteProgressCalculationError if error occured during route progress calculation.

Declaration

Swift

func calculateProgress(navigationSnapshot: NavigationSnapshot) throws -> [UUID : RouteProgress]

Parameters


                                navigationSnapshot

The snapshot of the current navigation session.

Return Value

A map of RouteProgress instances with route IDs as keys.