TomTom SDK for iOS TomTomRouteReplanningEngine

TomTomRouteReplanningEngine

public final class TomTomRouteReplanningEngine : RouteReplanningEngine

RouteReplanningEngine implementation.

Important

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

  • Creates a TomTomRouteReplanningEngine instance with default options.

    Declaration

    Swift

    public convenience init()

  • Creates a TomTomRouteReplanningEngine instance with the specified options.

    Declaration

    Swift

    public convenience init(options: RouteReplanningEngineOptions)

    Parameters

    options

    The options to configure the route replanning engine.

  • Initializes a new instance of TomTomRouteReplanningEngine.

    Declaration

    Swift

    public init(
    options: RouteReplanningEngineOptions,
    routeProposalSelector: RouteProposalSelector
)

    Parameters

    options

    The options to configure the route replanning engine.
    routeProposalSelector

    The selector responsible for choosing the best route.

  • Selector responsible for choosing the best route from a refreshed route and its alternatives

    Declaration

    Swift

    public var routeProposalSelector: RouteProposalSelector

  • Replans the route based on the given navigation snapshot and reason.

    Throws

    An error if the replanning fails.

    Declaration

    Swift

    public func replan(
    navigationSnapshot: NavigationSnapshot,
    reason: ReplanRequestReason,
    routeReplanner: TomTomSDKRouteReplanner.RouteReplanner
) async throws -> RouteReplanningResult

    Parameters

    navigationSnapshot

    The current navigation snapshot.
    reason

    The reason for the replan request.
    routeReplanner

    The route replanner to use for replanning.

    Return Value

    A RouteReplanningResult containing the result of the replanning.

  • Checks if it is time to refresh the current route. This function might be called on every location update, so it is the engine’s responsibility to limit the replanning frequency.

    Declaration

    Swift

    public func shouldReplanRoute(_ route: inout Route, navigationSnapshot: NavigationSnapshot) -> Bool

    Parameters

    route

    A route that should be checked.
    navigationSnapshot

    Current navigation snapshot.

    Return Value

    A Boolean value indicating whether we should replan the route.

  • Checks if it is time to advance guidance progress of the current route. This function might be called on every location update, so it is the engine’s responsibility to limit the replanning frequency.

    Declaration

    Swift

    public func shouldAdvanceGuidanceProgress(_ route: Route) -> Bool

    Parameters

    route

    A route that should be checked.

    Return Value

    A Boolean value that indicates whether the guidance progress should be advanced.