ReachableRangeQueryBuilder (Android Routing SDK

java.lang.Object
- com.tomtom.online.sdk.data.reachablerange.ReachableRangeQueryBuilder

All Implemented Interfaces:: IReachableRangeQuery

public class ReachableRangeQueryBuilder
extends java.lang.Object
implements IReachableRangeQuery

The default builder for ReachableRangeQuery objects.

Constructor Summary

Constructors
Constructor and Description

ReachableRangeQueryBuilder(LatLng origin)

Constructors
Constructor and Description
`ReachableRangeQueryBuilder(LatLng origin)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReachableRangeQuery`	`build()` Creates new instance of `ReachableRangeQuery`
`static ReachableRangeQueryBuilder`	`create(LatLng origin)` Creates an instance of `ReachableRangeQuery` with given origins and destinations lists.
`ReachableRangeQueryBuilder`	`withAccelerationEfficiency(java.lang.Double accelerationEfficiency)` Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.
`ReachableRangeQueryBuilder`	`withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)` Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
`ReachableRangeQueryBuilder`	`withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)` Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
`ReachableRangeQueryBuilder`	`withAvoidType(Avoid avoidType)` Specifies what the route calculation should try to avoid when determining the route.Can be specified multiple times.
`ReachableRangeQueryBuilder`	`withConsiderTraffic(java.lang.Boolean considerTraffic)` Specifies if all available traffic information should be considered during routing.
`ReachableRangeQueryBuilder`	`withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)` Specifies the speed-dependent component of consumption.
`ReachableRangeQueryBuilder`	`withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)` Specifies the speed-dependent component of consumption.
`ReachableRangeQueryBuilder`	`withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)` Specifies the current electric energy supply in kilowatt hours (kWh).
`ReachableRangeQueryBuilder`	`withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)` Specifies the current supply of fuel in liters.
`ReachableRangeQueryBuilder`	`withDecelerationEfficiency(java.lang.Double decelerationEfficiency)` Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.
`ReachableRangeQueryBuilder`	`withDepartAt(java.util.Date departAt)` Specifies the departure time.
`ReachableRangeQueryBuilder`	`withDownhillEfficiency(java.lang.Double downhillEfficiency)` Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.
`ReachableRangeQueryBuilder`	`withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh)` Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model.
`ReachableRangeQueryBuilder`	`withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters)` Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model.
`ReachableRangeQueryBuilder`	`withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)` Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
`ReachableRangeQueryBuilder`	`withHilliness(Hilliness hilliness)` Specifies the hilliness type for route calculation.
`ReachableRangeQueryBuilder`	`withMaxChargeInKWh(java.lang.Double maxChargeInKWh)` Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
`ReachableRangeQueryBuilder`	`withRouteType(RouteType routeType)` Specifies the route type.
`ReachableRangeQueryBuilder`	`withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds)` Time budget in seconds that determines the maximum range that can be travelled within given time.
`ReachableRangeQueryBuilder`	`withTravelMode(TravelMode travelMode)` Specifies the travel mode for route calculation.
`ReachableRangeQueryBuilder`	`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.
`ReachableRangeQueryBuilder`	`withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)` Specifies the vehicle axle weight for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleCommercial(java.lang.Boolean vehicleCommercial)` Specifies if the vehicle is used for commercial to calculate route.
`ReachableRangeQueryBuilder`	`withVehicleEngineType(VehicleEngineType vehicleEngineType)` Specifies the vehicle engine type for route query.
`ReachableRangeQueryBuilder`	`withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)` Specifies the vehicle height for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)` Specifies the vehicle length for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleLoadType(VehicleLoadType vehicleLoadType)` Specifies the vehicle load type for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)` Specifies the vehicle max speed for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)` Specifies the vehicle weight in kilograms for route calculation.
`ReachableRangeQueryBuilder`	`withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)` Specifies the vehicle width for route calculation.
`ReachableRangeQueryBuilder`	`withWindingness(Windingness windingness)` Specifies the windingness type for route calculation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReachableRangeQueryBuilder
```
public ReachableRangeQueryBuilder(LatLng origin)
```
- Method Detail
  - withFuelBudgetInLiters
```
public ReachableRangeQueryBuilder withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters)
```
    Description copied from interface: IReachableRangeQuery
    
    Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model. Required only for vehicles with combustion engine if IReachableRangeQuery.withTimeBudgetInSeconds(Double) is not used.
    
    Specified by:
    
    withFuelBudgetInLiters in interface IReachableRangeQuery
    
    Returns:
    
    reference to the ReachableRangeParams object
  - withEnergyBudgetInKWh
```
public ReachableRangeQueryBuilder withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh)
```
    Description copied from interface: IReachableRangeQuery
    
    Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model. Required only for vehicles with electric engine if IReachableRangeQuery.withTimeBudgetInSeconds(Double) is not used.
    
    Specified by:
    
    withEnergyBudgetInKWh in interface IReachableRangeQuery
    
    Returns:
    
    reference to the ReachableRangeParams object
  - withTimeBudgetInSeconds
```
public ReachableRangeQueryBuilder withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds)
```
    Description copied from interface: IReachableRangeQuery
    
    Time budget in seconds that determines the maximum range that can be travelled within given time. The consumption parameters will only affect eco-routes and thereby indirectly the driving time. Required only if neither IReachableRangeQuery.withFuelBudgetInLiters(Double) nor IReachableRangeQuery.withEnergyBudgetInKWh(Double) are called.
    
    Specified by:
    
    withTimeBudgetInSeconds in interface IReachableRangeQuery
    
    Returns:
    
    reference to the ReachableRangeParams object
  - withDepartAt
```
public ReachableRangeQueryBuilder withDepartAt(java.util.Date departAt)
```
    Specifies the departure time.
    
    Parameters:
    
    departAt -
    
    Returns:
    
    reference to the builder object
  - withRouteType
```
public ReachableRangeQueryBuilder withRouteType(RouteType routeType)
```
    Specifies the route type.
    
    Parameters:
    
    routeType -
    
    Returns:
    
    reference to the builder object
  - withConsiderTraffic
```
public ReachableRangeQueryBuilder withConsiderTraffic(java.lang.Boolean considerTraffic)
```
    Specifies if all available traffic information should be considered during routing.
    
    Parameters:
    
    considerTraffic -
    
    Returns:
    
    reference to the builder object
  - withAvoidType
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder withTravelMode(TravelMode travelMode)
```
    Specifies the travel mode for route calculation.
    
    Parameters:
    
    travelMode -
    
    Returns:
    
    reference to the common params object
  - withHilliness
```
public ReachableRangeQueryBuilder withHilliness(Hilliness hilliness)
```
    Specifies the hilliness type for route calculation.
    
    Parameters:
    
    hilliness -
    
    Returns:
    
    reference to the common params object
  - withWindingness
```
public ReachableRangeQueryBuilder withWindingness(Windingness windingness)
```
    Specifies the windingness type for route calculation.
    
    Parameters:
    
    windingness -
    
    Returns:
    
    reference to the common params object
  - withVehicleMaxSpeedInKph
```
public ReachableRangeQueryBuilder withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
```
    Specifies the vehicle max speed for route calculation.
    
    Parameters:
    
    vehicleMaxSpeedInKph -
    
    Returns:
    
    reference to the common params object
  - withVehicleWeightInKg
```
public ReachableRangeQueryBuilder withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
```
    Specifies the vehicle weight in kilograms for route calculation.
    
    Parameters:
    
    vehicleWeightInKg -
    
    Returns:
    
    reference to the common params object
  - withVehicleAxleWeightInKg
```
public ReachableRangeQueryBuilder withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
```
    Specifies the vehicle axle weight for route calculation.
    
    Parameters:
    
    vehicleAxleWeightInKg -
    
    Returns:
    
    reference to the common params object
  - withVehicleLengthInMeters
```
public ReachableRangeQueryBuilder withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
```
    Specifies the vehicle length for route calculation.
    
    Parameters:
    
    vehicleLengthInMeters -
    
    Returns:
    
    reference to the common params object
  - withVehicleWidthInMeters
```
public ReachableRangeQueryBuilder withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
```
    Specifies the vehicle width for route calculation.
    
    Parameters:
    
    vehicleWidthInMeters -
    
    Returns:
    
    reference to the common params object
  - withVehicleHeightInMeters
```
public ReachableRangeQueryBuilder withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
```
    Specifies the vehicle height for route calculation.
    
    Parameters:
    
    vehicleHeightInMeters -
    
    Returns:
    
    reference to the common params object
  - withVehicleCommercial
```
public ReachableRangeQueryBuilder withVehicleCommercial(java.lang.Boolean vehicleCommercial)
```
    Specifies if the vehicle is used for commercial to calculate route.
    
    Parameters:
    
    isVehicleCommercial -
    
    Returns:
    
    reference to the common params object
  - withVehicleLoadType
```
public ReachableRangeQueryBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)
```
    Specifies the vehicle load type for route calculation.
    
    Parameters:
    
    vehicleLoadType -
    
    Returns:
    
    reference to the common params object
  - withVehicleEngineType
```
public ReachableRangeQueryBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)
```
    Specifies the vehicle engine type for route query.
    
    Parameters:
    
    vehicleEngineType -
    
    Returns:
    
    reference to the common params object
  - withConstantSpeedConsumptionInLitersPerHundredKm
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder withAccelerationEfficiency(java.lang.Double accelerationEfficiency)
```
    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
  - withDecelerationEfficiency
```
public ReachableRangeQueryBuilder withDecelerationEfficiency(java.lang.Double decelerationEfficiency)
```
    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
  - withUphillEfficiency
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
```
public ReachableRangeQueryBuilder 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
  - create
```
public static ReachableRangeQueryBuilder create(LatLng origin)
```
    Creates an instance of ReachableRangeQuery with given origins and destinations lists.
    
    Parameters:
    
    origins - list of origin locations used to calculate matrix routes.
    
    destinations - list of destination locations used to calculate matrix routes.
    
    Returns:
    
    newly created builder object for ReachableRangeQuery to be used for further processing
  - build
```
public ReachableRangeQuery build()
```
    Creates new instance of ReachableRangeQuery

Class ReachableRangeQueryBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReachableRangeQueryBuilder

Method Detail

withFuelBudgetInLiters

withEnergyBudgetInKWh

withTimeBudgetInSeconds

withDepartAt

withRouteType

withConsiderTraffic

withAvoidType

withTravelMode

withHilliness

withWindingness

withVehicleMaxSpeedInKph

withVehicleWeightInKg

withVehicleAxleWeightInKg

withVehicleLengthInMeters

withVehicleWidthInMeters

withVehicleHeightInMeters

withVehicleCommercial

withVehicleLoadType

withVehicleEngineType

withConstantSpeedConsumptionInLitersPerHundredKm

withCurrentFuelInLiters

withAuxiliaryPowerInLitersPerHour

withFuelEnergyDensityInMJoulesPerLiter

withAccelerationEfficiency

withDecelerationEfficiency

withUphillEfficiency

withDownhillEfficiency

withConstantSpeedConsumptionInKWhPerHundredKm

withCurrentChargeInKWh

withMaxChargeInKWh

withAuxiliaryPowerInKW

create

build