navigation:engine/com.tomtom.sdk.navigation.replanning/RouteReplanningEngineOptions

RouteReplanningEngineOptions

class RouteReplanningEngineOptions( val pointDifferenceThreshold: Distance = DEFAULT_DIFFERENCE_THRESHOLD_IN_METERS, val pointDifferenceNumberThreshold: Int = DEFAULT_DIFFERENCE_NUMBER_THRESHOLD, val replanRouteInterval: Duration = DEFAULT_REPLAN_ROUTE_INTERVAL, val minTrafficDelay: Duration = DEFAULT_MIN_TRAFFIC_DELAY, val minTimeDifference: Duration = DEFAULT_MIN_TIME_DIFFERENCE, val validRemainingRouteDuration: Duration = DEFAULT_VALID_ROUTE_DURATION_REMAINING, val routeReplanningPolicy: RouteReplanningPolicy = RouteReplanningPolicy.REFRESH_ONLY)

Options used by GuidanceEngineFactory to create RouteReplanningEngine.

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

Parameters

pointDifferenceThreshold

Difference in point distance between the current route and the fetched route, exceeding which will cause the point of the fetched route to be considered invalid. If the amount of points exceeding the threshold is greater or equal to pointDifferenceNumberThreshold the fetched route is considered invalid.

pointDifferenceNumberThreshold

Number of points differing by at least pointDifferenceThreshold between the current and the fetched routes, exceeding which will cause the fetched route to be considered invalid and the route will not be replanned.

replanRouteInterval

Time interval which engine will ask for replan.

minTrafficDelay

Minimal traffic delay on current route to look for better alternative.

minTimeDifference

How much alternative route has to be faster to be used as replan proposal.

validRemainingRouteDuration

Defines till what point in time before arrival RouteReplanningEngine should try to replan a route.

routeReplanningPolicy

Specifies whether the RouteReplanningEngine should look for better alternative routes or just refresh the currently driven.

Constructors

RouteReplanningEngineOptions

fun RouteReplanningEngineOptions( pointDifferenceThreshold: Distance = DEFAULT_DIFFERENCE_THRESHOLD_IN_METERS, pointDifferenceNumberThreshold: Int = DEFAULT_DIFFERENCE_NUMBER_THRESHOLD, replanRouteInterval: Duration = DEFAULT_REPLAN_ROUTE_INTERVAL, minTrafficDelay: Duration = DEFAULT_MIN_TRAFFIC_DELAY, minTimeDifference: Duration = DEFAULT_MIN_TIME_DIFFERENCE, validRemainingRouteDuration: Duration = DEFAULT_VALID_ROUTE_DURATION_REMAINING, routeReplanningPolicy: RouteReplanningPolicy = RouteReplanningPolicy.REFRESH_ONLY)