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