CommonParams (Android Routing SDK

All Known Implementing Classes:

CommonParamsBuilder
```
public interface CommonParams<T extends CommonParams>
```
Interface used to specify common params that are used while using routing service. Used in CommonParamsBuilder class.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`withAccelerationEfficiency(java.lang.Double accelerationEfficiency)` Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.
`T`	`withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)` Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
`T`	`withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)` Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
`T`	`withAvoidType(Avoid avoidType)` Specifies what the route calculation should try to avoid when determining the route.
`T`	`withConsiderTraffic(java.lang.Boolean considerTraffic)` Specifies if all available traffic information should be considered during routing.
`T`	`withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)` Specifies the speed-dependent component of consumption.
`T`	`withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)` Specifies the speed-dependent component of consumption.
`T`	`withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)` Specifies the current electric energy supply in kilowatt hours (kWh).
`T`	`withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)` Specifies the current supply of fuel in liters.
`T`	`withDecelerationEfficiency(java.lang.Double decelerationEfficiency)` Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.
`T`	`withDepartAt(java.util.Date departAt)` Specifies the departure time.
`T`	`withDownhillEfficiency(java.lang.Double downhillEfficiency)` Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.
`T`	`withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)` Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
`T`	`withHilliness(Hilliness hilliness)` Specifies the hilliness type for route calculation.
`T`	`withIsVehicleCommercial(java.lang.Boolean isVehicleCommercial)` Specifies if the vehicle is used for commercial to calculate route.
`T`	`withMaxChargeInKWh(java.lang.Double maxChargeInKWh)` Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
`T`	`withRouteType(RouteType routeType)` Specifies the route type.
`T`	`withTravelMode(TravelMode travelMode)` Specifies the travel mode for route calculation.
`T`	`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.
`T`	`withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)` Specifies the vehicle axle weight for route calculation.
`T`	`withVehicleEngineType(VehicleEngineType vehicleEngineType)` Specifies the vehicle engine type for route query.
`T`	`withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)` Specifies the vehicle height for route calculation.
`T`	`withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)` Specifies the vehicle length for route calculation.
`T`	`withVehicleLoadType(VehicleLoadType vehicleLoadType)` Specifies the vehicle load type for route calculation.
`T`	`withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)` Specifies the vehicle max speed for route calculation.
`T`	`withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)` Specifies the vehicle weight in kilograms for route calculation.
`T`	`withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)` Specifies the vehicle width for route calculation.
`T`	`withWindingness(Windingness windingness)` Specifies the windingness type for route calculation.

- Method Detail
  - withDepartAt
```
T withDepartAt(java.util.Date departAt)
```
    Specifies the departure time.
    
    Parameters:
    
    departAt -
    
    Returns:
    
    reference to the common params object
  - withRouteType
```
T withRouteType(RouteType routeType)
```
    Specifies the route type.
    
    Parameters:
    
    routeType -
    
    Returns:
    
    reference to the common params object
  - withConsiderTraffic
```
T withConsiderTraffic(java.lang.Boolean considerTraffic)
```
    Specifies if all available traffic information should be considered during routing.
    
    Parameters:
    
    considerTraffic -
    
    Returns:
    
    reference to the common params object
  - withAvoidType
```
T withAvoidType(Avoid avoidType)
```
    Specifies what the route calculation should try to avoid when determining the route. Can be specified multiple times.
    
    Parameters:
    
    avoidType -
    
    Returns:
    
    reference to the common params object
  - withTravelMode
```
T withTravelMode(TravelMode travelMode)
```
    Specifies the travel mode for route calculation.
    
    Parameters:
    
    travelMode -
    
    Returns:
    
    reference to the common params object
  - withHilliness
```
T withHilliness(Hilliness hilliness)
```
    Specifies the hilliness type for route calculation.
    
    Parameters:
    
    hilliness -
    
    Returns:
    
    reference to the common params object
  - withWindingness
```
T withWindingness(Windingness windingness)
```
    Specifies the windingness type for route calculation.
    
    Parameters:
    
    windingness -
    
    Returns:
    
    reference to the common params object
  - withVehicleMaxSpeedInKph
```
T withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
```
    Specifies the vehicle max speed for route calculation.
    
    Parameters:
    
    vehicleMaxSpeedInKph -
    
    Returns:
    
    reference to the common params object
  - withVehicleWeightInKg
```
T withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
```
    Specifies the vehicle weight in kilograms for route calculation.
    
    Parameters:
    
    vehicleWeightInKg -
    
    Returns:
    
    reference to the common params object
  - withVehicleAxleWeightInKg
```
T withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
```
    Specifies the vehicle axle weight for route calculation.
    
    Parameters:
    
    vehicleAxleWeightInKg -
    
    Returns:
    
    reference to the common params object
  - withVehicleLengthInMeters
```
T withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
```
    Specifies the vehicle length for route calculation.
    
    Parameters:
    
    vehicleLengthInMeters -
    
    Returns:
    
    reference to the common params object
  - withVehicleWidthInMeters
```
T withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
```
    Specifies the vehicle width for route calculation.
    
    Parameters:
    
    vehicleWidthInMeters -
    
    Returns:
    
    reference to the common params object
  - withVehicleHeightInMeters
```
T withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
```
    Specifies the vehicle height for route calculation.
    
    Parameters:
    
    vehicleHeightInMeters -
    
    Returns:
    
    reference to the common params object
  - withIsVehicleCommercial
```
T withIsVehicleCommercial(java.lang.Boolean isVehicleCommercial)
```
    Specifies if the vehicle is used for commercial to calculate route.
    
    Parameters:
    
    isVehicleCommercial -
    
    Returns:
    
    reference to the common params object
  - withVehicleLoadType
```
T withVehicleLoadType(VehicleLoadType vehicleLoadType)
```
    Specifies the vehicle load type for route calculation.
    
    Parameters:
    
    vehicleLoadType -
    
    Returns:
    
    reference to the common params object
  - withVehicleEngineType
```
T withVehicleEngineType(VehicleEngineType vehicleEngineType)
```
    Specifies the vehicle engine type for route query.
    
    Parameters:
    
    vehicleEngineType -
    
    Returns:
    
    reference to the common params object
  - withConstantSpeedConsumptionInLitersPerHundredKm
```
T withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
```
    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.
    
    Parameters:
    
    constantSpeedConsumptionInLitersPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]
    
    Returns:
    
    reference to the common params object
  - withCurrentFuelInLiters
```
T withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)
```
    Specifies the current supply of fuel in liters. Applicable only for combustion engines.
    
    Parameters:
    
    currentFuelInLiters -
    
    Returns:
    
    reference to the common params object
  - withAuxiliaryPowerInLitersPerHour
```
T withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)
```
    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.
    
    Parameters:
    
    auxiliaryPowerInLitersPerHour -
    
    Returns:
    
    reference to the common params object
  - withFuelEnergyDensityInMJoulesPerLiter
```
T withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)
```
    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.
    
    Parameters:
    
    fuelEnergyDensityInMJoulesPerLiter -
    
    Returns:
    
    reference to the common params object
  - withAccelerationEfficiency
```
T 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). 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 #withDecelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.
    
    Parameters:
    
    accelerationEfficiency - valid values: [0.0, 1/decelerationEfficiency]
    
    Returns:
    
    reference to the common params object
  - withDecelerationEfficiency
```
T 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). 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 #withAccelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.
    
    Parameters:
    
    decelerationEfficiency - valid values: [0.0, 1/accelerationEfficiency]
    
    Returns:
    
    reference to the common params object
  - withUphillEfficiency
```
T 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). 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(double). If used, #withVehicleWeightInKg(int) has to be used as well.
    
    Parameters:
    
    uphillEfficiency - valid values: [0.0, 1/downhillEfficiency]
    
    Returns:
    
    reference to the common params object
  - withDownhillEfficiency
```
T 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). 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(double). If used, #withVehicleWeightInKg(int) has to be used as well.
    
    Parameters:
    
    downhillEfficiency - valid values: [0.0, 1/uphillEfficiency]
    
    Returns:
    
    reference to the common params object
  - withConstantSpeedConsumptionInKWhPerHundredKm
```
T withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
```
    Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs. Applicable only for electric engines.
    
    Parameters:
    
    constantSpeedConsumptionInKWhPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]
    
    Returns:
    
    reference to the common params object
  - withCurrentChargeInKWh
```
T withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)
```
    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(double).
    
    Parameters:
    
    currentChargeInKWh -
    
    Returns:
    
    reference to the common params object
  - withMaxChargeInKWh
```
T withMaxChargeInKWh(java.lang.Double maxChargeInKWh)
```
    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(double).
    
    Parameters:
    
    maxChargeInKWh -
    
    Returns:
    
    reference to the common params object
  - withAuxiliaryPowerInKW
```
T withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)
```
    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.
    
    Parameters:
    
    auxiliaryPowerInKW -
    
    Returns:
    
    reference to the common params object

Interface CommonParams<T extends CommonParams>

Method Summary

Method Detail

withDepartAt

withRouteType

withConsiderTraffic

withAvoidType

withTravelMode

withHilliness

withWindingness

withVehicleMaxSpeedInKph

withVehicleWeightInKg

withVehicleAxleWeightInKg

withVehicleLengthInMeters

withVehicleWidthInMeters

withVehicleHeightInMeters

withIsVehicleCommercial

withVehicleLoadType

withVehicleEngineType

withConstantSpeedConsumptionInLitersPerHundredKm

withCurrentFuelInLiters

withAuxiliaryPowerInLitersPerHour

withFuelEnergyDensityInMJoulesPerLiter

withAccelerationEfficiency

withDecelerationEfficiency

withUphillEfficiency

withDownhillEfficiency

withConstantSpeedConsumptionInKWhPerHundredKm

withCurrentChargeInKWh

withMaxChargeInKWh

withAuxiliaryPowerInKW