public interface CommonParams
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. |
CommonParams |
withAccelerationEfficiency(double accelerationEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to kinetic
energy when the vehicle accelerates (i.e.
|
CommonParams |
withAllowVignettes(java.util.List<java.lang.String> allowVignettes)
A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which toll roads with
vignettes are allowed.
|
CommonParams |
withAuxiliaryPowerInKW(double auxiliaryPowerInKW)
Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
|
CommonParams |
withAuxiliaryPowerInLitersPerHour(double auxiliaryPowerInLitersPerHour)
Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in
liters per hour.
|
CommonParams |
withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
A list of rectangles that define areas that are to be avoided during reachable range
calculation.
|
CommonParams |
withAvoidType(Avoid avoidType)
Specifies what the route calculation should try to avoid when determining the route.
|
CommonParams |
withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes)
A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads
with vignettes are to be avoided.
|
CommonParams |
withConsiderTraffic(boolean considerTraffic)
Specifies if all available traffic information should be considered during routing.
|
CommonParams |
withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
Specifies the speed-dependent component of consumption.
|
CommonParams |
withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
Specifies the speed-dependent component of consumption.
|
CommonParams |
withCurrentChargeInKWh(double currentChargeInKWh)
Specifies the current electric energy supply in kilowatt hours (kWh).
|
CommonParams |
withCurrentFuelInLiters(double currentFuelInLiters)
Specifies the current supply of fuel in liters.
|
CommonParams |
withDecelerationEfficiency(double decelerationEfficiency)
Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the
vehicle decelerates (i.e.
|
CommonParams |
withDepartAt(java.util.Date departAt)
Specifies the departure time.
|
CommonParams |
withDownhillEfficiency(double downhillEfficiency)
Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the
vehicle loses elevation (i.e.
|
CommonParams |
withFuelEnergyDensityInMJoulesPerLiter(double fuelEnergyDensityInMJoulesPerLiter)
Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
|
CommonParams |
withHilliness(Hilliness hilliness)
Specifies the hilliness type for route calculation.
|
CommonParams |
withIsVehicleCommercial(boolean isVehicleCommercial)
Specifies if the vehicle is used for commercial to calculate route.
|
CommonParams |
withMaxChargeInKWh(double maxChargeInKWh)
Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
|
CommonParams |
withReport(Report report)
Specifies what data should be reported for diagnostic purposes.
|
CommonParams |
withRouteType(RouteType routeType)
Specifies the route type.
|
CommonParams |
withTravelMode(TravelMode travelMode)
Specifies the travel mode for route calculation.
|
CommonParams |
withUphillEfficiency(double uphillEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to potential energy
when the vehicle gains elevation (i.e.
|
CommonParams |
withVehicleAxleWeightInKg(int vehicleAxleWeightInKg)
Specifies the vehicle axle weight for route calculation.
|
CommonParams |
withVehicleEngineType(VehicleEngineType vehicleEngineType)
Specifies the vehicle engine type for route query.
|
CommonParams |
withVehicleHeightInMeters(double vehicleHeightInMeters)
Specifies the vehicle height for route calculation.
|
CommonParams |
withVehicleLengthInMeters(double vehicleLengthInMeters)
Specifies the vehicle length for route calculation.
|
CommonParams |
withVehicleLoadType(VehicleLoadType vehicleLoadType)
Specifies the vehicle load type for route calculation.
|
CommonParams |
withVehicleMaxSpeedInKph(int vehicleMaxSpeedInKph)
Specifies the vehicle max speed for route calculation.
|
CommonParams |
withVehicleWeightInKg(int vehicleWeightInKg)
Specifies the vehicle weight in kilograms for route calculation.
|
CommonParams |
withVehicleWidthInMeters(double vehicleWidthInMeters)
Specifies the vehicle width for route calculation.
|
CommonParams |
withWindingness(Windingness windingness)
Specifies the windingness type for route calculation.
|
long getNativeHandle()
dispose()
is called.void dispose()
CommonParams withReport(Report report)
report
- CommonParams withDepartAt(java.util.Date departAt)
departAt
- CommonParams withRouteType(RouteType routeType)
routeType
- CommonParams withConsiderTraffic(boolean considerTraffic)
considerTraffic
- CommonParams withAvoidType(Avoid avoidType)
avoidType
- CommonParams withTravelMode(TravelMode travelMode)
travelMode
- CommonParams withHilliness(Hilliness hilliness)
hilliness
- CommonParams withWindingness(Windingness windingness)
windingness
- CommonParams withVehicleMaxSpeedInKph(int vehicleMaxSpeedInKph)
vehicleMaxSpeedInKph
- CommonParams withVehicleWeightInKg(int vehicleWeightInKg)
vehicleWeightInKg
- CommonParams withVehicleAxleWeightInKg(int vehicleAxleWeightInKg)
vehicleAxleWeightInKg
- CommonParams withVehicleLengthInMeters(double vehicleLengthInMeters)
vehicleLengthInMeters
- CommonParams withVehicleWidthInMeters(double vehicleWidthInMeters)
vehicleWidthInMeters
- CommonParams withVehicleHeightInMeters(double vehicleHeightInMeters)
vehicleHeightInMeters
- CommonParams withIsVehicleCommercial(boolean isVehicleCommercial)
isVehicleCommercial
- CommonParams withVehicleLoadType(VehicleLoadType vehicleLoadType)
vehicleLoadType
- CommonParams withVehicleEngineType(VehicleEngineType vehicleEngineType)
vehicleEngineType
- CommonParams withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
constantSpeedConsumptionInLitersPerHundredKm
- constraints: size - [1, 25], consumption
value - [0.01, 100000.0]CommonParams withCurrentFuelInLiters(double currentFuelInLiters)
currentFuelInLiters
- CommonParams withAuxiliaryPowerInLitersPerHour(double auxiliaryPowerInLitersPerHour)
auxiliaryPowerInLitersPerHour
- CommonParams withFuelEnergyDensityInMJoulesPerLiter(double fuelEnergyDensityInMJoulesPerLiter)
fuelEnergyDensityInMJoulesPerLiter
- CommonParams withAccelerationEfficiency(double accelerationEfficiency)
withDecelerationEfficiency(double)
.
If used, withVehicleWeightInKg(int)
has to be used as well.accelerationEfficiency
- valid values: [0.0, 1/decelerationEfficiency]CommonParams withDecelerationEfficiency(double decelerationEfficiency)
withAccelerationEfficiency(double)
.
If used, withVehicleWeightInKg(int)
has to be used as well.decelerationEfficiency
- valid values: [0.0, 1/accelerationEfficiency]CommonParams withUphillEfficiency(double uphillEfficiency)
withDownhillEfficiency(double)
.
If used, withVehicleWeightInKg(int)
has to be used as well.uphillEfficiency
- valid values: [0.0, 1/downhillEfficiency]CommonParams withDownhillEfficiency(double downhillEfficiency)
withUphillEfficiency(double)
.
If used, withVehicleWeightInKg(int)
has to be used as well.downhillEfficiency
- valid values: [0.0, 1/uphillEfficiency]CommonParams withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
constantSpeedConsumptionInKWhPerHundredKm
- constraints: size - [1, 25], consumption
value - [0.01, 100000.0]CommonParams withCurrentChargeInKWh(double currentChargeInKWh)
withMaxChargeInKWh(double)
.currentChargeInKWh
- CommonParams withMaxChargeInKWh(double maxChargeInKWh)
withCurrentChargeInKWh(double)
.maxChargeInKWh
- CommonParams withAuxiliaryPowerInKW(double auxiliaryPowerInKW)
auxiliaryPowerInKW
- CommonParams withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes)
avoidVignettes
- CommonParams withAllowVignettes(java.util.List<java.lang.String> allowVignettes)
allowVignettes
- CommonParams withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
avoidAreas
-