TomTom SDK for iOS StandaloneRouteProgressEngine

StandaloneRouteProgressEngine

public final class StandaloneRouteProgressEngine : RouteProgressEngine

A class responsible for calculating route progress in a standalone manner.

Important

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

  • Creates aStandaloneRouteProgressEngine instance.

    Declaration

    Swift

    public convenience init()

  • Calculates the progress for each route in the navigation snapshot.

    Throws

    An error if progress calculation fails.

    Declaration

    Swift

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

    Parameters

    navigationSnapshot

    The snapshot of the current navigation state.

    Return Value

    A dictionary mapping route IDs to their respective RouteProgress.

  • Resets the state of the StandaloneRouteProgressEngine.

    Declaration

    Swift

    public func reset()