RouteRangeOptions Class

Initializes a new RouteRangeOptions instance for mocking.

RouteRangeOptions constructor.

RouteRangeOptions constructor.

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

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

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

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.

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:

• by linear interpolation, if the given speed lies in between two speeds in the list
• by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

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:

• by linear interpolation, if the given speed lies in between two speeds in the list.
• by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list.

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

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

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

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

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.

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

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.

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

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

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

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

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

The Coordinate from which the range calculation should start.

The type of route requested.

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.

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.

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

Possible values:

• true - Do consider all available traffic information during routing
• false - Ignore current traffic data during routing. Note that although the current traffic data is ignored

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

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

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

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

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/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.

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.

• A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
• A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.

Weight of the vehicle in kilograms.

• It is mandatory if any of the *Efficiency parameters are set.
• It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.
• If no detailed Consumption Model is specified and the value of vehicleWeight is non-zero, then weight restrictions are considered.
• In all other cases, this parameter is ignored.

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

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