sdk-routing / com.tomtom.online.sdk.routing.reachablerange / ReachableRangeBudgetDescriptor / Builder

Builder

@PublicPreview("2021.06") class Builder

Builder used to create an instance of ReachableRangeBudgetDescriptor. Once constructed, the user cannot change the field values.

Constructors

<init>

Builder()

Builder used to create an instance of ReachableRangeBudgetDescriptor. Once constructed, the user cannot change the field values.

Functions

build

fun build(): ReachableRangeBudgetDescriptor

Constructs a new ReachableRangeBudgetDescriptor.

distanceBudgetInMeters

fun distanceBudgetInMeters(distanceBudgetInMeters: Double): ReachableRangeBudgetDescriptor.Builder

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.

energyBudgetInKWh

fun energyBudgetInKWh(energyBudgetInKWh: Double): ReachableRangeBudgetDescriptor.Builder

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

fuelBudgetInLiters

fun fuelBudgetInLiters(fuelBudgetInLiters: Double): ReachableRangeBudgetDescriptor.Builder

Fuel budget in liters that determines the maximum range that can be traveled using the specified Combustion Consumption Model.

timeBudgetInSeconds

fun timeBudgetInSeconds(timeBudgetInSeconds: Double): ReachableRangeBudgetDescriptor.Builder

Time budget in seconds that determines the maximum range that can be traveled within a given time. The consumption parameters will only affect eco-routes and thereby indirectly affect the driving time.