@DeprecatedSince("2020.06", "com.tomtom.online.sdk.routing.reachablerange.ReachableRangeSpecification.Builder") class ReachableRangeQueryBuilder : IReachableRangeQueryThe default builder for {@link ReachableRangeQuery} objects.
ReachableRangeQueryBuilder(origin: LatLng)
The default builder for {@link ReachableRangeQuery} objects. |
var accelerationEfficiency: Double? |
|
var adrTunnelRestrictionCode: AdrTunnelRestrictionCode? |
|
var auxiliaryPowerInKW: Double? |
|
var auxiliaryPowerInLitersPerHour: Double? |
|
var avoidList: List<Avoid>? |
|
var avoidType: Avoid? |
|
var considerTraffic: Boolean? |
|
var constantSpeedConsumptionInKWhPerHundredKm: SpeedToConsumptionMap? |
|
var constantSpeedConsumptionInLitersPerHundredKm: SpeedToConsumptionMap? |
|
var currentChargeInKWh: Double? |
|
var currentFuelInLiters: Double? |
|
var decelerationEfficiency: Double? |
|
var departAt: Date? |
|
var distanceBudgetInMeters: Double? |
|
var downhillEfficiency: Double? |
|
var energyBudgetInKWh: Double? |
|
var fuelBudgetInLiters: Double? |
|
var fuelEnergyDensityInMJoulesPerLiter: Double? |
|
var hilliness: Hilliness? |
|
var maxChargeInKWh: Double? |
|
var origin: LatLng |
|
var routeType: RouteType? |
|
var timeBudgetInSeconds: Double? |
|
var travelMode: TravelMode? |
|
var uphillEfficiency: Double? |
|
var vehicleAxleWeightInKg: Int? |
|
var vehicleCommercial: Boolean? |
|
var vehicleEngineType: VehicleEngineType? |
|
var vehicleHeightInMeters: Double? |
|
var vehicleLengthInMeters: Double? |
|
var vehicleLoadType: VehicleLoadType? |
|
var vehicleMaxSpeedInKph: Int? |
|
var vehicleWeightInKg: Int? |
|
var vehicleWidthInMeters: Double? |
|
var windingness: Windingness? |
fun build(): ReachableRangeQuery
Creates a new instance of ReachableRangeQuery. |
|
fun withAccelerationEfficiency(accelerationEfficiency: Double): ReachableRangeQueryBuilder
Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e., KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. |
|
fun withAdrTunnelRestrictionCode(adrTunnelRestrictionCode: AdrTunnelRestrictionCode): ReachableRangeQueryBuilder
If vehicleAdrTunnelRestrictionCode is specified, the vehicle is subject to ADR tunnel restrictions. |
|
fun withAuxiliaryPowerInKW(auxiliaryPowerInKW: Double): ReachableRangeQueryBuilder
Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc. Applicable only for electric engines. |
|
fun withAuxiliaryPowerInLitersPerHour(auxiliaryPowerInLitersPerHour: Double): ReachableRangeQueryBuilder
Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc. Applicable only for combustion engines. |
|
fun withAvoidList(avoidList: List<Avoid>): ReachableRangeQueryBuilder
Specifies what the route calculation should try to avoid when determining the route. |
|
fun withAvoidType(avoidType: Avoid): ReachableRangeQueryBuilder
Specifies what the route calculation should try to avoid when determining the route. |
|
fun withConsiderTraffic(considerTraffic: Boolean): ReachableRangeQueryBuilder
Specifies if all available traffic information should be considered during routing. |
|
fun withConstantSpeedConsumptionInKWhPerHundredKm(constantSpeedConsumptionInKWhPerHundredKm: SpeedToConsumptionMap): ReachableRangeQueryBuilder
Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs. Applicable only for electric engines. |
|
fun withConstantSpeedConsumptionInLitersPerHundredKm(constantSpeedConsumptionInLitersPerHundredKm: SpeedToConsumptionMap): ReachableRangeQueryBuilder
Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in liters-per-100km pairs. Applicable only for combustion engines. |
|
fun withCurrentChargeInKWh(currentChargeInKWh: Double): ReachableRangeQueryBuilder
Specifies the current electric energy supply in kilowatt hours (kWh). Applicable only for electric engines. If used at all, must be used in conjunction with .withMaxChargeInKWh. |
|
fun withCurrentFuelInLiters(currentFuelInLiters: Double): ReachableRangeQueryBuilder
Specifies the current supply of fuel in liters. Applicable only for combustion engines. |
|
fun withDecelerationEfficiency(decelerationEfficiency: Double): ReachableRangeQueryBuilder
Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e., ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. |
|
fun withDepartAt(departAt: Date): ReachableRangeQueryBuilder
Specifies the departure time. |
|
fun withDistanceBudgetInMeters(distanceBudgetInMeters: Double): ReachableRangeQueryBuilder
The distance budget in meters that determines the maximum range which can be traveled. The Consumption Model will only affect the range when the routeType is eco. |
|
fun withDownhillEfficiency(downhillEfficiency: Double): ReachableRangeQueryBuilder
Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with .withUphillEfficiency. If used, .withVehicleWeightInKg has to be used as well. |
|
fun withEnergyBudgetInKWh(energyBudgetInKWh: Double): ReachableRangeQueryBuilder
Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be traveled using the specified Electric Consumption Model. |
|
fun withFuelBudgetInLiters(fuelBudgetInLiters: Double): ReachableRangeQueryBuilder
Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model. |
|
fun withFuelEnergyDensityInMJoulesPerLiter(fuelEnergyDensityInMJoulesPerLiter: Double): ReachableRangeQueryBuilder
Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel. Applicable only for combustion engines. |
|
fun withHilliness(hilliness: Hilliness): ReachableRangeQueryBuilder
Specifies the hilliness type for route calculation. |
|
fun withMaxChargeInKWh(maxChargeInKWh: Double): ReachableRangeQueryBuilder
Specifies the capacity of the vehicle's battery in kilowatt hours (kWh). Applicable only for electric engines. If used at all, must be used in conjunction with .withCurrentChargeInKWh. |
|
fun withRouteType(routeType: RouteType): ReachableRangeQueryBuilder
Specifies the route type. |
|
fun withTimeBudgetInSeconds(timeBudgetInSeconds: Double): ReachableRangeQueryBuilder
Time budget in seconds that determines the maximum range that can be traveled within a given time. The consumption parameters will only affect eco-routes and thereby indirectly affect the driving time. |
|
fun withTravelMode(travelMode: TravelMode): ReachableRangeQueryBuilder
Specifies the travel mode for route calculation. |
|
fun withUphillEfficiency(uphillEfficiency: Double): ReachableRangeQueryBuilder
Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with .withDownhillEfficiency. If used, .withVehicleWeightInKg has to be used as well. |
|
fun withVehicleAxleWeightInKg(vehicleAxleWeightInKg: Int): ReachableRangeQueryBuilder
Specifies the vehicle axle weight for route calculation. |
|
fun withVehicleCommercial(vehicleCommercial: Boolean): ReachableRangeQueryBuilder
Specifies if the vehicle is used for commercial to calculate route. |
|
fun withVehicleEngineType(vehicleEngineType: VehicleEngineType): ReachableRangeQueryBuilder
Specifies the vehicle engine type for route query. |
|
fun withVehicleHeightInMeters(vehicleHeightInMeters: Double): ReachableRangeQueryBuilder
Specifies the vehicle height for route calculation. |
|
fun withVehicleLengthInMeters(vehicleLengthInMeters: Double): ReachableRangeQueryBuilder
Specifies the vehicle length for route calculation. |
|
fun withVehicleLoadType(vehicleLoadType: VehicleLoadType): ReachableRangeQueryBuilder
Specifies the vehicle load type for route calculation. |
|
fun withVehicleMaxSpeedInKph(vehicleMaxSpeedInKph: Int): ReachableRangeQueryBuilder
Specifies the vehicle max speed for route calculation. |
|
fun withVehicleWeightInKg(vehicleWeightInKg: Int): ReachableRangeQueryBuilder
Specifies the vehicle weight in kilograms for route calculation. |
|
fun withVehicleWidthInMeters(vehicleWidthInMeters: Double): ReachableRangeQueryBuilder
Specifies the vehicle width for route calculation. |
|
fun withWindingness(windingness: Windingness): ReachableRangeQueryBuilder
Specifies the windingness type for route calculation. |
fun create(origin: LatLng): ReachableRangeQueryBuilder
Creates an instance of ReachableRangeQueryBuilder with given origin. |