com.tomtom.online.sdk.routing.data

Class RouteQueryBuilder

java.lang.Object

com.tomtom.online.sdk.routing.data.RouteQueryBuilder

All Implemented Interfaces:

IRouteQuery

public class RouteQueryBuilder
extends java.lang.Object
implements IRouteQuery

The default implementation of RouteQuery object which is used to prepare the query for the Routing API.

Constructor Summary

Constructors

Constructor and Description
RouteQueryBuilder(LatLng origPosition, LatLng destPosition)

Method Summary

Modifier and Type	Method and Description
RouteQuery	build() Creates new instance of RouteQuery
static RouteQueryBuilder	create(LatLng origPosition, LatLng destPosition) Creates an instance of RouteQuery with given origin and destination.
RouteQueryBuilder	withAccelerationEfficiency(java.lang.Double accelerationEfficiency) Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.
RouteQueryBuilder	withAllowVignette(java.lang.String allowVignette)
RouteQueryBuilder	withAllowVignettes(java.util.List<java.lang.String> allowVignettes) List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are allowed.
RouteQueryBuilder	withAlternativeType(AlternativeType alternativeType) Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.
RouteQueryBuilder	withArriveAt(java.util.Date arriveAt) Specifies the desired arrival time for the route to calculation.
RouteQueryBuilder	withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW) Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
RouteQueryBuilder	withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour) Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
RouteQueryBuilder	withAvoidArea(com.tomtom.online.sdk.common.location.BoundingBox avoidArea)
RouteQueryBuilder	withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas) A list of rectangles that define areas that are to be avoided during route calculation.
RouteQueryBuilder	withAvoidType(Avoid avoidType) Specifies what the route calculation should try to avoid when determining the route.Can be specified multiple times.
RouteQueryBuilder	withAvoidVignette(java.lang.String avoidVignette)
RouteQueryBuilder	withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes) List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.
RouteQueryBuilder	withComputeBestOrder(java.lang.Boolean computeBestOrder) Specifies if the best order of waypoints should be used to compute route.
RouteQueryBuilder	withComputeTravelTimeFor(TravelTimeType computeTravelTimeFor) Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.
RouteQueryBuilder	withConsiderTraffic(java.lang.Boolean considerTraffic) Specifies if all available traffic information should be considered during routing.
RouteQueryBuilder	withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm) Specifies the speed-dependent component of consumption.
RouteQueryBuilder	withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm) Specifies the speed-dependent component of consumption.
RouteQueryBuilder	withCurrentChargeInKWh(java.lang.Double currentChargeInKWh) Specifies the current electric energy supply in kilowatt hours (kWh).
RouteQueryBuilder	withCurrentFuelInLiters(java.lang.Double currentFuelInLiters) Specifies the current supply of fuel in liters.
RouteQueryBuilder	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.
RouteQueryBuilder	withDepartAt(java.util.Date departAt) Specifies the departure time.
RouteQueryBuilder	withDownhillEfficiency(java.lang.Double downhillEfficiency) Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.
RouteQueryBuilder	withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter) Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
RouteQueryBuilder	withHilliness(Hilliness hilliness) Specifies the hilliness type for route calculation.
RouteQueryBuilder	withInstructionsType(InstructionsType instructionsType) Specifies the instructions type for the route calculation.
RouteQueryBuilder	withLanguage(java.lang.String language) Specifies the language used for route calculation.
RouteQueryBuilder	withMaxAlternatives(java.lang.Integer maxAlternatives) Specifies the maximal number of route alternatives to be calculated by service.
RouteQueryBuilder	withMaxChargeInKWh(java.lang.Double maxChargeInKWh) Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
RouteQueryBuilder	withMinDeviationDistance(java.lang.Integer minDeviationDistance) All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters.
RouteQueryBuilder	withMinDeviationTime(java.lang.Integer minDeviationTime) All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds.
RouteQueryBuilder	withReport(Report report) Specifies if the report should be provided on route query response.
RouteQueryBuilder	withRouteRepresentation(RouteRepresentation routeRepresentation) Specifies the route representation for the route calculation.
RouteQueryBuilder	withRouteType(RouteType routeType) Specifies the route type.
RouteQueryBuilder	withSectionType(SectionType sectionType) Specifies which of the section types is reported in the route response.
RouteQueryBuilder	withSupportingPoint(LatLng supportingPoint)
RouteQueryBuilder	withSupportingPoints(java.util.List<LatLng> supportingPoints) A list of base route points to be used as input for route reconstruction.
RouteQueryBuilder	withTravelMode(TravelMode travelMode) Specifies the travel mode for route calculation.
RouteQueryBuilder	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.
RouteQueryBuilder	withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg) Specifies the vehicle axle weight for route calculation.
RouteQueryBuilder	withVehicleCommercial(java.lang.Boolean vehicleCommercial) Specifies if the vehicle is used for commercial to calculate route.
RouteQueryBuilder	withVehicleEngineType(VehicleEngineType vehicleEngineType) Specifies the vehicle engine type for route query.
RouteQueryBuilder	withVehicleHeading(java.lang.Integer vehicleHeading) Specifies the vehicle heading for route calculation.
RouteQueryBuilder	withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters) Specifies the vehicle height for route calculation.
RouteQueryBuilder	withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters) Specifies the vehicle length for route calculation.
RouteQueryBuilder	withVehicleLoadType(VehicleLoadType vehicleLoadType) Specifies the vehicle load type for route calculation.
RouteQueryBuilder	withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph) Specifies the vehicle max speed for route calculation.
RouteQueryBuilder	withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg) Specifies the vehicle weight in kilograms for route calculation.
RouteQueryBuilder	withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters) Specifies the vehicle width for route calculation.
RouteQueryBuilder	withWayPoints(LatLng[] wayPoints) Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.
RouteQueryBuilder	withWayPointsList(java.util.List<LatLng> wayPointsList) Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.
RouteQueryBuilder	withWayPointsWithAcc(java.util.List<com.tomtom.online.sdk.common.location.LatLngAcc> wayPointsWithAcc) Specifies the array of map coordinate whose geographical information your waypoints with radius for the route calculation.
RouteQueryBuilder	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

RouteQueryBuilder

public RouteQueryBuilder(LatLng origPosition,
                         LatLng destPosition)

Method Detail

withWayPoints

public RouteQueryBuilder withWayPoints(LatLng[] wayPoints)

Description copied from interface: IRouteQuery

Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.

Specified by:

withWayPoints in interface IRouteQuery

Returns:

the route query

withWayPointsList

public RouteQueryBuilder withWayPointsList(java.util.List<LatLng> wayPointsList)

Description copied from interface: IRouteQuery

Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.

Specified by:

withWayPointsList in interface IRouteQuery

Returns:

the route query

withWayPointsWithAcc

public RouteQueryBuilder withWayPointsWithAcc(java.util.List<com.tomtom.online.sdk.common.location.LatLngAcc> wayPointsWithAcc)

Description copied from interface: IRouteQuery

Specifies the array of map coordinate whose geographical information your waypoints with radius for the route calculation.

Specified by:

withWayPointsWithAcc in interface IRouteQuery

Returns:

the route query

withMaxAlternatives

public RouteQueryBuilder withMaxAlternatives(java.lang.Integer maxAlternatives)

Description copied from interface: IRouteQuery

Specifies the maximal number of route alternatives to be calculated by service.

Specified by:

withMaxAlternatives in interface IRouteQuery

Returns:

the route query

withAlternativeType

public RouteQueryBuilder withAlternativeType(AlternativeType alternativeType)

Description copied from interface: IRouteQuery

Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.

Specified by:

withAlternativeType in interface IRouteQuery

Returns:

the route query

withMinDeviationDistance

public RouteQueryBuilder withMinDeviationDistance(java.lang.Integer minDeviationDistance)

Description copied from interface: IRouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

Specified by:

withMinDeviationDistance in interface IRouteQuery

Returns:

the route query

withMinDeviationTime

public RouteQueryBuilder withMinDeviationTime(java.lang.Integer minDeviationTime)

Description copied from interface: IRouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

Specified by:

withMinDeviationTime in interface IRouteQuery

Returns:

the route query

withInstructionsType

public RouteQueryBuilder withInstructionsType(InstructionsType instructionsType)

Description copied from interface: IRouteQuery

Specifies the instructions type for the route calculation.

Specified by:

withInstructionsType in interface IRouteQuery

Returns:

the route query

withLanguage

public RouteQueryBuilder withLanguage(java.lang.String language)

Description copied from interface: IRouteQuery

Specifies the language used for route calculation.

Specified by:

withLanguage in interface IRouteQuery

Returns:

the route query

withComputeBestOrder

public RouteQueryBuilder withComputeBestOrder(java.lang.Boolean computeBestOrder)

Description copied from interface: IRouteQuery

Specifies if the best order of waypoints should be used to compute route. In example: if the maximum allowed number of waypoints is 50 then it might be reduced to 20 in better order.

Specified by:

withComputeBestOrder in interface IRouteQuery

Returns:

the route query

withRouteRepresentation

public RouteQueryBuilder withRouteRepresentation(RouteRepresentation routeRepresentation)

Description copied from interface: IRouteQuery

Specifies the route representation for the route calculation.

Specified by:

withRouteRepresentation in interface IRouteQuery

Returns:

the route query

withComputeTravelTimeFor

public RouteQueryBuilder withComputeTravelTimeFor(TravelTimeType computeTravelTimeFor)

Description copied from interface: IRouteQuery

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

Specified by:

withComputeTravelTimeFor in interface IRouteQuery

Returns:

the route query

withVehicleHeading

public RouteQueryBuilder withVehicleHeading(java.lang.Integer vehicleHeading)

Description copied from interface: IRouteQuery

Specifies the vehicle heading for route calculation.

Specified by:

withVehicleHeading in interface IRouteQuery

Returns:

the route query

withSectionType

public RouteQueryBuilder withSectionType(SectionType sectionType)

Description copied from interface: IRouteQuery

Specifies which of the section types is reported in the route response.

Specified by:

withSectionType in interface IRouteQuery

Returns:

the route query

withReport

public RouteQueryBuilder withReport(Report report)

Description copied from interface: IRouteQuery

Specifies if the report should be provided on route query response.

Specified by:

withReport in interface IRouteQuery

Returns:

the route query

withSupportingPoint

public RouteQueryBuilder withSupportingPoint(LatLng supportingPoint)

withSupportingPoints

public RouteQueryBuilder withSupportingPoints(java.util.List<LatLng> supportingPoints)

Description copied from interface: IRouteQuery

A list of base route points to be used as input for route reconstruction.

Specified by:

withSupportingPoints in interface IRouteQuery

Returns:

the route query

withAvoidVignette

public RouteQueryBuilder withAvoidVignette(java.lang.String avoidVignette)

withAvoidVignettes

public RouteQueryBuilder withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes)

Description copied from interface: IRouteQuery

List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.

Specified by:

withAvoidVignettes in interface IRouteQuery

Returns:

the route query

withAllowVignette

public RouteQueryBuilder withAllowVignette(java.lang.String allowVignette)

withAllowVignettes

public RouteQueryBuilder withAllowVignettes(java.util.List<java.lang.String> allowVignettes)

Description copied from interface: IRouteQuery

List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are allowed.

Specified by:

withAllowVignettes in interface IRouteQuery

Returns:

the route query

withArriveAt

public RouteQueryBuilder withArriveAt(java.util.Date arriveAt)

Description copied from interface: IRouteQuery

Specifies the desired arrival time for the route to calculation.

Specified by:

withArriveAt in interface IRouteQuery

Returns:

the route query

withAvoidArea

public RouteQueryBuilder withAvoidArea(com.tomtom.online.sdk.common.location.BoundingBox avoidArea)

withAvoidAreas

public RouteQueryBuilder withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)

Description copied from interface: IRouteQuery

A list of rectangles that define areas that are to be avoided during route calculation.

Specified by:

withAvoidAreas in interface IRouteQuery

Returns:

the route query

withDepartAt

public RouteQueryBuilder withDepartAt(java.util.Date departAt)

Specifies the departure time.

Specified by:

withDepartAt in interface IRouteQuery

Parameters:

departAt -

Returns:

reference to the builder object

withRouteType

public RouteQueryBuilder withRouteType(RouteType routeType)

Specifies the route type.

Specified by:

withRouteType in interface IRouteQuery

Parameters:

routeType -

Returns:

reference to the builder object

withConsiderTraffic

public RouteQueryBuilder withConsiderTraffic(java.lang.Boolean considerTraffic)

Specifies if all available traffic information should be considered during routing.

Specified by:

withConsiderTraffic in interface IRouteQuery

Parameters:

considerTraffic -

Returns:

reference to the builder object

withAvoidType

public RouteQueryBuilder withAvoidType(Avoid avoidType)

Specifies what the route calculation should try to avoid when determining the route.Can be specified multiple times.

Specified by:

withAvoidType in interface IRouteQuery

Parameters:

avoidType -

Returns:

reference to the common params object

withTravelMode

public RouteQueryBuilder withTravelMode(TravelMode travelMode)

Specifies the travel mode for route calculation.

Specified by:

withTravelMode in interface IRouteQuery

Parameters:

travelMode -

Returns:

reference to the common params object

withHilliness

public RouteQueryBuilder withHilliness(Hilliness hilliness)

Specifies the hilliness type for route calculation.

Specified by:

withHilliness in interface IRouteQuery

Parameters:

hilliness -

Returns:

reference to the common params object

withWindingness

public RouteQueryBuilder withWindingness(Windingness windingness)

Specifies the windingness type for route calculation.

Specified by:

withWindingness in interface IRouteQuery

Parameters:

windingness -

Returns:

reference to the common params object

withVehicleMaxSpeedInKph

public RouteQueryBuilder withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)

Specifies the vehicle max speed for route calculation.

Specified by:

withVehicleMaxSpeedInKph in interface IRouteQuery

Parameters:

vehicleMaxSpeedInKph -

Returns:

reference to the common params object

withVehicleWeightInKg

public RouteQueryBuilder withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)

Specifies the vehicle weight in kilograms for route calculation.

Specified by:

withVehicleWeightInKg in interface IRouteQuery

Parameters:

vehicleWeightInKg -

Returns:

reference to the common params object

withVehicleAxleWeightInKg

public RouteQueryBuilder withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)

Specifies the vehicle axle weight for route calculation.

Specified by:

withVehicleAxleWeightInKg in interface IRouteQuery

Parameters:

vehicleAxleWeightInKg -

Returns:

reference to the common params object

withVehicleLengthInMeters

public RouteQueryBuilder withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)

Specifies the vehicle length for route calculation.

Specified by:

withVehicleLengthInMeters in interface IRouteQuery

Parameters:

vehicleLengthInMeters -

Returns:

reference to the common params object

withVehicleWidthInMeters

public RouteQueryBuilder withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)

Specifies the vehicle width for route calculation.

Specified by:

withVehicleWidthInMeters in interface IRouteQuery

Parameters:

vehicleWidthInMeters -

Returns:

reference to the common params object

withVehicleHeightInMeters

public RouteQueryBuilder withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)

Specifies the vehicle height for route calculation.

Specified by:

withVehicleHeightInMeters in interface IRouteQuery

Parameters:

vehicleHeightInMeters -

Returns:

reference to the common params object

withVehicleCommercial

public RouteQueryBuilder withVehicleCommercial(java.lang.Boolean vehicleCommercial)

Specifies if the vehicle is used for commercial to calculate route.

Specified by:

withVehicleCommercial in interface IRouteQuery

Parameters:

isVehicleCommercial -

Returns:

reference to the common params object

withVehicleLoadType

public RouteQueryBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)

Specifies the vehicle load type for route calculation.

Specified by:

withVehicleLoadType in interface IRouteQuery

Parameters:

vehicleLoadType -

Returns:

reference to the common params object

withVehicleEngineType

public RouteQueryBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)

Specifies the vehicle engine type for route query.

Specified by:

withVehicleEngineType in interface IRouteQuery

Parameters:

vehicleEngineType -

Returns:

reference to the common params object

withConstantSpeedConsumptionInLitersPerHundredKm

public RouteQueryBuilder 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.

Specified by:

withConstantSpeedConsumptionInLitersPerHundredKm in interface IRouteQuery

Parameters:

constantSpeedConsumptionInLitersPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]

Returns:

reference to the common params object

withCurrentFuelInLiters

public RouteQueryBuilder withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)

Specifies the current supply of fuel in liters. Applicable only for combustion engines.

Specified by:

withCurrentFuelInLiters in interface IRouteQuery

Parameters:

currentFuelInLiters -

Returns:

reference to the common params object

withAuxiliaryPowerInLitersPerHour

public RouteQueryBuilder 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.

Specified by:

withAuxiliaryPowerInLitersPerHour in interface IRouteQuery

Parameters:

auxiliaryPowerInLitersPerHour -

Returns:

reference to the common params object

withFuelEnergyDensityInMJoulesPerLiter

public RouteQueryBuilder 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.

Specified by:

withFuelEnergyDensityInMJoulesPerLiter in interface IRouteQuery

Parameters:

fuelEnergyDensityInMJoulesPerLiter -

Returns:

reference to the common params object

withAccelerationEfficiency

public RouteQueryBuilder 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.

Specified by:

withAccelerationEfficiency in interface IRouteQuery

Parameters:

decelerationEfficiency - valid values: [0.0, 1/accelerationEfficiency]

Returns:

reference to the common params object

withDecelerationEfficiency

public RouteQueryBuilder 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.

Specified by:

withDecelerationEfficiency in interface IRouteQuery

Parameters:

uphillEfficiency - valid values: [0.0, 1/downhillEfficiency]

Returns:

reference to the common params object

withUphillEfficiency

public RouteQueryBuilder 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.

Specified by:

withUphillEfficiency in interface IRouteQuery

Parameters:

uphillEfficiency - valid values: [0.0, 1/downhillEfficiency]

Returns:

reference to the common params object

withDownhillEfficiency

public RouteQueryBuilder 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.

Specified by:

withDownhillEfficiency in interface IRouteQuery

Parameters:

downhillEfficiency - valid values: [0.0, 1/uphillEfficiency]

Returns:

reference to the common params object

withConstantSpeedConsumptionInKWhPerHundredKm

public RouteQueryBuilder 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.

Specified by:

withConstantSpeedConsumptionInKWhPerHundredKm in interface IRouteQuery

Parameters:

constantSpeedConsumptionInKWhPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]

Returns:

reference to the common params object

withCurrentChargeInKWh

public RouteQueryBuilder 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).

Specified by:

withCurrentChargeInKWh in interface IRouteQuery

Parameters:

currentChargeInKWh -

Returns:

reference to the common params object

withMaxChargeInKWh

public RouteQueryBuilder 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).

Specified by:

withMaxChargeInKWh in interface IRouteQuery

Parameters:

maxChargeInKWh -

Returns:

reference to the common params object

withAuxiliaryPowerInKW

public RouteQueryBuilder 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.

Specified by:

withAuxiliaryPowerInKW in interface IRouteQuery

Parameters:

auxiliaryPowerInKW -

Returns:

reference to the common params object

create

public static RouteQueryBuilder create(LatLng origPosition,
                                       LatLng destPosition)

Creates an instance of RouteQuery with given origin and destination.

Returns:

newly created builder object for RouteQuery to be used for further processing

build

public RouteQuery build()

Creates new instance of RouteQuery