TomTom SDK for iOS RouteProgress

RouteProgress

public struct RouteProgress

Represents progress along the route.

Important

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

  • Initializes RouteProgress with the distance along the route and the array of remaining route stop progress.

    Precondition

    The argument remainingRouteStopsProgress must contain at least one RouteStopProgress object for a destination. If the array is empty, the program stops execution.

    Declaration

    Swift

    public init(
    distanceAlongRoute: Measurement<UnitLength>,
    remainingRouteStopsProgress: [RouteStopProgress]
)

    Parameters

    distanceAlongRoute

    Distance along the route from the departure to the current location.
    remainingRouteStopsProgress

    Array of individual RouteStopProgress for remaining routeStops from the current location to the destination.

  • Distance along the route from the departure to the current location.

    Declaration

    Swift

    public let distanceAlongRoute: Measurement<UnitLength>

  • Array of individual RouteStopProgress for remaining routeStops from the current location to the destination.

    Declaration

    Swift

    public let remainingRouteStopsProgress: [RouteStopProgress]

  • Remaining delay along the route from the current location to the destination, attributed to traffic congestion.

    Declaration

    Swift

    public var remainingTrafficDelay: Measurement<UnitDuration> { get }

  • Estimated remaining travel time from the current location to the destination.

    Declaration

    Swift

    public var remainingTime: Measurement<UnitDuration> { get }

  • Remaining distance along the route from the current location to the destination.

    Declaration

    Swift

    public var remainingDistance: Measurement<UnitLength> { get }