DynamicRoutingEngineOptions

public struct DynamicRoutingEngineOptions : Hashable

Options defining the behavior of the DynamicRoutingEngine. Both, minTimeDifference and minTimeDifferencePercentage, will be checked: When the poll interval is reached, the smaller difference will win and the DynamicRoutingDelegate is notified.

  • The value is in the range of [0, 1] over the remaining (current position to next waypoint) To get notified, the following check must be true: oldEstimatedTimeOfArrival - newEstimatedTimeOfArrival >= newRouteDuration * [min_time_difference_percentage]. A value of 0 will be treated as nil meaning no event will be sent. In order to receive events the difference needs to be greater than 0. Defaults to nil.

    Declaration

    Swift

    public var minTimeDifferencePercentage: Double?

  • The minimum time difference, before notifying the DynamicRoutingDelegate. To get notified, the following check must be true: oldEstimatedTimeOfArrival - newEstimatedTimeOfArrival > DynamicRoutingEngineOptions.minTimeDifference. A value of 0 will be treated as nil meaning no event will be sent. In order to receive events the difference needs to be greater than 0. Defaults to nil.

    Declaration

    Swift

    public var minTimeDifference: TimeInterval?

  • The poll interval. Zero duration triggers a route calculation with each position update. Triggered via DynamicRoutingEngine.updateCurrentLocation(...) Defaults to 15 minutes.

    Declaration

    Swift

    public var pollInterval: TimeInterval

  • Creates an instance of this class.

    Declaration

    Swift

    public init(minTimeDifferencePercentage: Double? = nil, minTimeDifference: TimeInterval? = nil, pollInterval: TimeInterval = 15 * 60)