public class CommonParamsBuilder extends java.lang.Object implements CommonParams<CommonParamsBuilder>, PostCommonParams<CommonParamsBuilder>, SupportsReportParam<CommonParamsBuilder>, com.tomtom.online.sdk.common.jni.JniNativeHandleOwner
Constructor and Description |
---|
CommonParamsBuilder()
A constructor for the params builder that creates a native handle.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose() |
long |
getNativeHandle() |
CommonParamsBuilder |
withAccelerationEfficiency(java.lang.Double accelerationEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to kinetic
energy when the vehicle accelerates (i.e., KineticEnergyGained/ChemicalEnergyConsumed).
|
CommonParamsBuilder |
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(java.lang.Double auxiliaryPowerInKW)
Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
|
CommonParamsBuilder |
withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)
Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle in
liters per hour.
|
CommonParamsBuilder |
withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
A list of rectangles that define areas to be avoided during a 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(java.lang.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(java.lang.Double currentChargeInKWh)
Specifies the current electric energy supply in kilowatt hours (kWh).
|
CommonParamsBuilder |
withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)
Specifies the current supply of fuel in liters.
|
CommonParamsBuilder |
withDecelerationEfficiency(java.lang.Double decelerationEfficiency)
Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the
vehicle decelerates (i.e., ChemicalEnergySaved/KineticEnergyLost).
|
CommonParamsBuilder |
withDepartAt(java.util.Date departAt)
Specifies the departure time.
|
CommonParamsBuilder |
withDownhillEfficiency(java.lang.Double downhillEfficiency)
Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the
vehicle loses elevation (i.e., ChemicalEnergySaved/PotentialEnergyLost).
|
CommonParamsBuilder |
withFuelEnergyDensityInMJoulesPerLiter(java.lang.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(java.lang.Boolean isVehicleCommercial)
Specifies if the vehicle is used for commercial purposes to calculate route.
|
CommonParamsBuilder |
withMaxChargeInKWh(java.lang.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(java.lang.Double uphillEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to potential energy
when the vehicle gains elevation (i.e., PotentialEnergyGained/ChemicalEnergyConsumed).
|
CommonParamsBuilder |
withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
Specifies the vehicle axle weight for route calculation.
|
CommonParamsBuilder |
withVehicleEngineType(VehicleEngineType vehicleEngineType)
Specifies the vehicle engine type for route query.
|
CommonParamsBuilder |
withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
Specifies the vehicle height for route calculation.
|
CommonParamsBuilder |
withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
Specifies the vehicle length for route calculation.
|
CommonParamsBuilder |
withVehicleLoadType(VehicleLoadType vehicleLoadType)
Specifies the vehicle load type for route calculation.
|
CommonParamsBuilder |
withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
Specifies the vehicle max speed for route calculation.
|
CommonParamsBuilder |
withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
Specifies the vehicle weight in kilograms for route calculation.
|
CommonParamsBuilder |
withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
Specifies the vehicle width for route calculation.
|
CommonParamsBuilder |
withWindingness(Windingness windingness)
Specifies the windingness type for route calculation.
|
public CommonParamsBuilder()
public long getNativeHandle()
getNativeHandle
in interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner
public void dispose()
dispose
in interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner
@NonNull public CommonParamsBuilder withReport(Report report)
SupportsReportParam
withReport
in interface SupportsReportParam<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withDepartAt(java.util.Date departAt)
CommonParams
withDepartAt
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withRouteType(RouteType routeType)
CommonParams
withRouteType
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withConsiderTraffic(java.lang.Boolean considerTraffic)
CommonParams
withConsiderTraffic
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAvoidType(Avoid avoidType)
CommonParams
withAvoidType
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withTravelMode(TravelMode travelMode)
CommonParams
withTravelMode
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withHilliness(Hilliness hilliness)
CommonParams
withHilliness
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withWindingness(Windingness windingness)
CommonParams
withWindingness
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
CommonParams
withVehicleMaxSpeedInKph
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
CommonParams
withVehicleWeightInKg
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
CommonParams
withVehicleAxleWeightInKg
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
CommonParams
withVehicleLengthInMeters
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
CommonParams
withVehicleWidthInMeters
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
CommonParams
withVehicleHeightInMeters
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withIsVehicleCommercial(java.lang.Boolean isVehicleCommercial)
CommonParams
withIsVehicleCommercial
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)
CommonParams
withVehicleLoadType
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)
CommonParams
withVehicleEngineType
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withConstantSpeedConsumptionInLitersPerHundredKm(@NonNull SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
CommonParams
withConstantSpeedConsumptionInLitersPerHundredKm
in interface CommonParams<CommonParamsBuilder>
constantSpeedConsumptionInLitersPerHundredKm
- constraints: size - [1, 25], consumption
value - [0.01, 100000.0]@NonNull public CommonParamsBuilder withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)
CommonParams
withCurrentFuelInLiters
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)
CommonParams
withAuxiliaryPowerInLitersPerHour
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)
CommonParams
withFuelEnergyDensityInMJoulesPerLiter
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAccelerationEfficiency(java.lang.Double accelerationEfficiency)
CommonParams
#withDecelerationEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withAccelerationEfficiency
in interface CommonParams<CommonParamsBuilder>
accelerationEfficiency
- valid values: [0.0, 1/decelerationEfficiency]@NonNull public CommonParamsBuilder withDecelerationEfficiency(java.lang.Double decelerationEfficiency)
CommonParams
#withAccelerationEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withDecelerationEfficiency
in interface CommonParams<CommonParamsBuilder>
decelerationEfficiency
- valid values: [0.0, 1/accelerationEfficiency]@NonNull public CommonParamsBuilder withUphillEfficiency(java.lang.Double uphillEfficiency)
CommonParams
#withDownhillEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withUphillEfficiency
in interface CommonParams<CommonParamsBuilder>
uphillEfficiency
- valid values: [0.0, 1/downhillEfficiency]@NonNull public CommonParamsBuilder withDownhillEfficiency(java.lang.Double downhillEfficiency)
CommonParams
#withUphillEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withDownhillEfficiency
in interface CommonParams<CommonParamsBuilder>
downhillEfficiency
- valid values: [0.0, 1/uphillEfficiency]@NonNull public CommonParamsBuilder withConstantSpeedConsumptionInKWhPerHundredKm(@NonNull SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
CommonParams
withConstantSpeedConsumptionInKWhPerHundredKm
in interface CommonParams<CommonParamsBuilder>
constantSpeedConsumptionInKWhPerHundredKm
- constraints: size - [1, 25], consumption
value - [0.01, 100000.0]@NonNull public CommonParamsBuilder withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)
CommonParams
#withMaxChargeInKWh(double)
.withCurrentChargeInKWh
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withMaxChargeInKWh(java.lang.Double maxChargeInKWh)
CommonParams
#withCurrentChargeInKWh(double)
.withMaxChargeInKWh
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)
CommonParams
withAuxiliaryPowerInKW
in interface CommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAvoidVignettes(@NonNull java.util.List<java.lang.String> avoidVignettes)
PostCommonParams
withAvoidVignettes
in interface PostCommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAllowVignettes(@Nullable java.util.List<java.lang.String> allowVignettes)
PostCommonParams
withAllowVignettes
in interface PostCommonParams<CommonParamsBuilder>
@NonNull public CommonParamsBuilder withAvoidAreas(@Nullable java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
PostCommonParams
withAvoidAreas
in interface PostCommonParams<CommonParamsBuilder>