ReachableRangeOptionsBuilder

public class ReachableRangeOptionsBuilder : RoutingOptionsBuilder

Important

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

Public

  • Sets the fuel budget in liters that determines the maximum range which can be traveled using the specified Combustion Consumption Model.

    Minimum value: 0

    Maximum value: currentFuelInLiters (if specified)

    When fuelBudgetInLiters is used, a detailed Combustion Consumption Model must be specified.

    Declaration

    Swift

    public func with(fuelBudgetInLiters: Float) -> Self

  • Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be traveled using the specified Electric Consumption Model.

    Minimum value: 0

    Maximum value: currentChargeInkWh (if specified)

    When energyBudgetInkWh is used, a detailed Electric Consumption Model must be specified.

    Declaration

    Swift

    public func with(energyBudgetInkWh: Float) -> Self

  • The time budget in seconds that determines the maximum range that can be traveled. The Consumption Model will only affect the range when the routeType is eco. Minimum value: 0

    Declaration

    Swift

    public func with(timeBudgetInSec: Float) -> Self

  • The distance budget in meters that determines the maximum range which can be traveled. The Consumption Model will only affect the range when the routeType is eco.

    Declaration

    Swift

    public func with(distanceBudgetInMeters: Float) -> Self