RouteRangeOptions Class

Definition

Options for rendering static images.

public class RouteRangeOptions
type RouteRangeOptions = class
Public Class RouteRangeOptions
Inheritance
RouteRangeOptions

Constructors

RouteRangeOptions()

Initializes a new RouteRangeOptions instance for mocking.

RouteRangeOptions(Double, Double)

RouteRangeOptions constructor.

RouteRangeOptions(GeoPosition)

RouteRangeOptions constructor.

Properties

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. Must be paired with decelerationEfficiency. The range of values allowed are 0.0 to 1/decelerationEfficiency. Sensible Values : for Combustion Model : 0.33, for Electric Model : 0.66

AuxiliaryPowerInKilowatts

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. Sensible Values : 1.7

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. Sensible Values : 0.2

Avoid

Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request. In calculateReachableRange requests, the value alreadyUsedRoads must not be used.

ConstantSpeedConsumptionInKilowattHoursPerHundredKilometer

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing. Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates. Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed. The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0. Sensible Values : 50,8.2:130,21.3 This parameter is required for Electric consumption model.

ConstantSpeedConsumptionInLitersPerHundredKilometer

Specifies the speed-dependent component of consumption. Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing. Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates. Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed. The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0. Sensible Values : 50,6.3:130,11.5 Note : This parameter is required for The Combustion Consumption Model.

CurrentChargeInKilowattHours

Specifies the current electric energy supply in kilowatt hours (kWh). This parameter co-exists with MaxChargeInKilowattHours parameter. The range of values allowed are 0.0 to MaxChargeInKilowattHours. Sensible Values : 43

CurrentFuelInLiters

Specifies the current supply of fuel in liters. Sensible Values : 55

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. Must be paired with AccelerationEfficiency. The range of values allowed are 0.0 to 1/AccelerationEfficiency. Sensible Values : for Combustion Model : 0.83, for Electric Model : 0.91

DepartAt

The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).

DistanceBudgetInMeters

Distance budget in meters that determines maximal range which can be travelled using driving distance. The Consumption Model will only affect the range when routeType is eco.

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. Must be paired with UphillEfficiency. The range of values allowed are 0.0 to 1/UphillEfficiency. Sensible Values : for Combustion Model : 0.51, for Electric Model : 0.73

EnergyBudgetInKilowattHours

Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model.<br> When EnergyBudgetInKilowattHours is used, it is mandatory to specify a detailed Electric Consumption Model.

FuelBudgetInLiters

Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.

FuelEnergyDensityInMegajoulesPerLiter

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. This parameter is required if any Efficiency parameter is set. Sensible Values : 34.2

InclineLevel

Degree of hilliness for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.

IsCommercialVehicle

Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads.

MaxChargeInKilowattHours

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery. This parameter co-exists with CurrentChargeInKilowattHours parameter. Minimum value has to be greater than or equal to CurrentChargeInKilowattHours. Sensible Values : 85

Query

The Coordinate from which the range calculation should start.

RouteType

The type of route requested.

TimeBudget

Time budget in TimeSpan that determines maximal range which can be travelled using driving time. The Consumption Model will only affect the range when routeType is eco.

TravelMode

The mode of travel for the requested route. If not defined, default is car. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In calculateReachableRange requests, the values bicycle and pedestrian must not be used.

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. Must be paired with DownhillEfficiency. The range of values allowed are 0.0 to 1/DownhillEfficiency. Sensible Values : for Combustion Model : 0.27, for Electric Model : 0.74

UseTrafficData

Possible values:

During routing, the effect of historic traffic on effective road speeds is still incorporated.

VehicleAxleWeightInKilograms

Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.

VehicleEngineType

Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of vehicleEngineType.

VehicleHeightInMeters

Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.

VehicleLengthInMeters

Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.

VehicleLoadType

Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.

VehicleMaxSpeedInKilometersPerHour

Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.

VehicleWeightInKilograms

Weight of the vehicle in kilograms.

Sensible Values : for Combustion Model : 1600, for Electric Model : 1900

VehicleWidthInMeters

Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.

Windingness

Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling.

Applies to