com.tomtom.online.sdk.data.reachablerange

Interface ReachableRangeParams

All Superinterfaces:

com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

All Known Implementing Classes:

ReachableRangeParamsBuilder

public interface ReachableRangeParams
extends com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

Interface used to specify key parameters for reachable range such as energy and fuel budget. Extends native class to access native object's unique id and native handle. Implemented in default reachable range params builder ReachableRangeParamsBuilder.

Field Summary

Fields inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

EMPTY_HANDLE

Method Summary

Modifier and Type	Method and Description
ReachableRangeParams	withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh) Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model.
ReachableRangeParams	withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters) Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model.
ReachableRangeParams	withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds) Time budget in seconds that determines the maximum range that can be travelled within given time.

Methods inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

dispose, getNativeHandle

Method Detail

withFuelBudgetInLiters

ReachableRangeParams withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters)

Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model. Required only for vehicles with combustion engine if withTimeBudgetInSeconds(Double) is not used.

Parameters:

fuelBudgetInLiters -

Returns:

reference to the ReachableRangeParams object

withEnergyBudgetInKWh

ReachableRangeParams withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh)

Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model. Required only for vehicles with electric engine if withTimeBudgetInSeconds(Double) is not used.

Parameters:

energyBudgetInKWh -

Returns:

reference to the ReachableRangeParams object

withTimeBudgetInSeconds

ReachableRangeParams withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds)

Time budget in seconds that determines the maximum range that can be travelled within given time. The consumption parameters will only affect eco-routes and thereby indirectly the driving time. Required only if neither withFuelBudgetInLiters(Double) nor withEnergyBudgetInKWh(Double) are called.

Parameters:

timeBudgetInSeconds -

Returns:

reference to the ReachableRangeParams object