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.


                    
                    
                    init(distanceAlongRoute:remainingRouteStopsProgress:)

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.

Throws

The error missingDestinationProgress if missingDestinationProgress doesn’t contain at least one RouteStopProgress.

Declaration

Swift

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

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.

InitializationError
Errors that can be thrown during the creation of RouteProgress.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum InitializationError : Error
distanceAlongRoute
Distance along the route from the departure to the current location.
Declaration
Swift

public let distanceAlongRoute: Measurement<UnitLength>
remainingRouteStopsProgress
Array of individual RouteStopProgress for remaining routeStops from the current location to the destination.
Declaration
Swift

public let remainingRouteStopsProgress: [RouteStopProgress]
remainingTrafficDelay
Remaining delay along the route from the current location to the destination, attributed to traffic congestion.
Declaration
Swift

public var remainingTrafficDelay: Measurement<UnitDuration> { get }
remainingTime
Estimated remaining travel time from the current location to the destination.
Declaration
Swift

public var remainingTime: Measurement<UnitDuration> { get }
remainingDistance
Remaining distance along the route from the current location to the destination.
Declaration
Swift

public var remainingDistance: Measurement<UnitLength> { get }