interface CommonParams<T : CommonParams<CommonParams<*>>!>
An interface used to specify common params when using the Routing service. Used in CommonParamsBuilder class.
abstract fun withAccelerationEfficiency(accelerationEfficiency: Double!): T
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. Applicable only to combustion engines. If used at all, it must be used in conjunction with #withDecelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well. |
|
abstract fun withAuxiliaryPowerInKW(auxiliaryPowerInKW: Double!): T
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 to electric engines. |
|
abstract fun withAuxiliaryPowerInLitersPerHour(auxiliaryPowerInLitersPerHour: Double!): T
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 to combustion engines. |
|
abstract fun withAvoidType(avoidType: Avoid!): T
Specifies what the route calculation should try to avoid when determining the route. It can be specified multiple times. |
|
abstract fun withConsiderTraffic(considerTraffic: Boolean!): T
Specifies if all available traffic information should be considered during routing. |
|
abstract fun withConstantSpeedConsumptionInKWhPerHundredKm(constantSpeedConsumptionInKWhPerHundredKm: SpeedToConsumptionMap!): T
Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs. Applicable only to electric engines. |
|
abstract fun withConstantSpeedConsumptionInLitersPerHundredKm(constantSpeedConsumptionInLitersPerHundredKm: SpeedToConsumptionMap!): T
Specifies the speed-dependent component of consumption. It is provided as an unordered list of speed/consumption-rate in liters-per-100km pairs. Applicable only to combustion engines. |
|
abstract fun withCurrentChargeInKWh(currentChargeInKWh: Double!): T
Specifies the current electric energy supply in kilowatt hours (kWh). Applicable only to electric engines. If used at all, it must be used in conjunction with #withMaxChargeInKWh(double). |
|
abstract fun withCurrentFuelInLiters(currentFuelInLiters: Double!): T
Specifies the current supply of fuel in liters. Applicable only to combustion engines. |
|
abstract fun withDecelerationEfficiency(decelerationEfficiency: Double!): T
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. Applicable only to combustion engines. If used at all, it must be used in conjunction with #withAccelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well. |
|
abstract fun withDepartAt(departAt: Date!): T
Specifies the departure time. |
|
abstract fun withDownhillEfficiency(downhillEfficiency: Double!): T
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 to combustion engines. If used at all, it must be used in conjunction with #withUphillEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well. |
|
abstract fun withFuelEnergyDensityInMJoulesPerLiter(fuelEnergyDensityInMJoulesPerLiter: Double!): T
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 to combustion engines. |
|
abstract fun withHilliness(hilliness: Hilliness!): T
Specifies the hilliness type for route calculation. |
|
abstract fun withIsVehicleCommercial(isVehicleCommercial: Boolean!): T
Specifies if the vehicle is used for commercial purposes to calculate route. |
|
abstract fun withMaxChargeInKWh(maxChargeInKWh: Double!): T
Specifies the capacity of the vehicle's battery in kilowatt hours (kWh). Applicable only to electric engines. If used at all, it must be used in conjunction with #withCurrentChargeInKWh(double). |
|
abstract fun withRouteType(routeType: RouteType!): T
Specifies the route type. |
|
abstract fun withTravelMode(travelMode: TravelMode!): T
Specifies the travel mode for route calculation. |
|
abstract fun withUphillEfficiency(uphillEfficiency: Double!): T
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 to combustion engines. If used at all, it must be used in conjunction with #withDownhillEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well. |
|
abstract fun withVehicleAdrTunnelRestrictionCode(adrTunnelRestrictionCode: AdrTunnelRestrictionCode!): T
If vehicleAdrTunnelRestrictionCode is specified, the vehicle is subject to ADR tunnel restrictions. |
|
abstract fun withVehicleAxleWeightInKg(vehicleAxleWeightInKg: Int!): T
Specifies the vehicle axle weight for route calculation. |
|
abstract fun withVehicleEngineType(vehicleEngineType: VehicleEngineType!): T
Specifies the vehicle engine type for route query. |
|
abstract fun withVehicleHeightInMeters(vehicleHeightInMeters: Double!): T
Specifies the vehicle height for route calculation. |
|
abstract fun withVehicleLengthInMeters(vehicleLengthInMeters: Double!): T
Specifies the vehicle length for route calculation. |
|
abstract fun withVehicleLoadType(vehicleLoadType: VehicleLoadType!): T
Specifies the vehicle load type for route calculation. |
|
abstract fun withVehicleMaxSpeedInKph(vehicleMaxSpeedInKph: Int!): T
Specifies the vehicle max speed for route calculation. |
|
abstract fun withVehicleWeightInKg(vehicleWeightInKg: Int!): T
Specifies the vehicle weight in kilograms for route calculation. |
|
abstract fun withVehicleWidthInMeters(vehicleWidthInMeters: Double!): T
Specifies the vehicle width for route calculation. |
|
abstract fun withWindingness(windingness: Windingness!): T
Specifies the windingness type for route calculation. |
open class CommonParamsBuilder : CommonParams<CommonParamsBuilder!>, PostCommonParams<CommonParamsBuilder!>, SupportsReportParam<CommonParamsBuilder!>, JniNativeHandleOwner
A class used to build commonly used params using native handle to native service. |