TomTom SDK for iOS TomTomArrivalDetectionEngine

TomTomArrivalDetectionEngine

public class TomTomArrivalDetectionEngine : ArrivalDetectionEngine

Responsible for detecting the arrival at destinations or waypoints during navigation.

The TomTomArrivalDetectionEngine evaluates the current navigation state to determine if the driver has arrived at a destination or a waypoint based on specified distance and time thresholds.

Important

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

  • Creates a new arrival detection engine instance.

    Declaration

    Swift

    public convenience init()

  • Checks if the driver has reached the destination.

    Evaluates the current navigation snapshot to determine if the driver has reached the destination based on the distance and time thresholds.

    Throws

    NavigationProcessingError.routeDataMissing if there is no activeRoute on the NavigationSnapshot.

    Declaration

    Swift

    public func hasArrivedAtDestination(navigationSnapshot: NavigationSnapshot) throws -> DestinationArrivalStatus

    Parameters

    navigationSnapshot

    A snapshot of the current route navigation session.

    Return Value

    A DestinationArrivalStatus with information about whether the user has arrived.

  • Checks the arrival state of the next waypoint based on the NavigationSnapshot.

    Evaluates whether the driver has arrived at, passed, or is still on the way to the specified waypoint based on the current navigation snapshot.

    Throws

    An error if the arrival status cannot be determined.

    Declaration

    Swift

    public func hasArrivedAtWaypoint(
    waypoint: RouteStop,
    navigationSnapshot: NavigationSnapshot
) throws -> WaypointStatus

    Parameters

    waypoint

    The waypoint to check for arrival status.
    navigationSnapshot

    A snapshot of the current route navigation session.

    Return Value

    A WaypointStatus with information about whether the user has arrived at the waypoint.

  • Resets the arrival detection engine, clearing any internal state.

    Warning

    This method has not been implemented yet.

    Declaration

    Swift

    public func reset()