com.tomtom.online.sdk.data.reachablerange

Interface ReachableRangeParams

All Known Implementing Classes:

ReachableRangeParamsBuilder

public interface ReachableRangeParams

Method Summary

Modifier and Type	Method and Description
void	dispose() Remove all internal references, clear memory, invalidate the native handle.
long	getNativeHandle() Get unique query id, valid until dispose() is called.
ReachableRangeParams	withEnergyBudgetInKWh(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(double fuelBudgetInLiters) Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model.
ReachableRangeParams	withTimeBudgetInSeconds(double timeBudgetInSeconds) Time budget in seconds that determines the maximum range that can be travelled within given time.

Method Detail

getNativeHandle

long getNativeHandle()

Get unique query id, valid until dispose() is called.

dispose

void dispose()

Remove all internal references, clear memory, invalidate the native handle.

withFuelBudgetInLiters

ReachableRangeParams withFuelBudgetInLiters(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(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(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