Package com.azure.maps.route.models

Class RouteRangeOptions

java.lang.Object

com.azure.maps.route.models.BaseRouteOptions<RouteRangeOptions>

com.azure.maps.route.models.RouteRangeOptions

public class RouteRangeOptions
extends BaseRouteOptions<RouteRangeOptions>

Options class for a get route range call.

Constructor Summary

Constructors

Constructor	Description
RouteRangeOptions(com.azure.core.models.GeoPosition startingPoint)	Builds a new RouteRangeOptions.
RouteRangeOptions(com.azure.core.models.GeoPosition startingPoint, Duration timeBudgetInSec)	Builds a new RouteRangeOptions.

Method Summary

Modifier and Type	Method	Description
Double	getDistanceBudgetInMeters()	Returns the distance budget in meters.
Double	getEnergyBudgetInKwH()	Returns the energy budget in KwH.
Double	getFuelBudgetInLiters()	Returns the fuel budget in liters.
com.azure.core.models.GeoPosition	getStartingPoint()	Returns the starting point.
Duration	getTimeBudgetInSec()	Returns the time budget in seconds.
RouteRangeOptions	setDistanceBudgetInMeters(Double distanceBudgetInMeters)	Sets the distance budget in meters.
RouteRangeOptions	setEnergyBudgetInKwH(Double energyBudgetInKwH)	Sets the energy budget in KwH
RouteRangeOptions	setFuelBudgetInLiters(Double fuelBudgetInLiters)	Sets the fuel budget in liters.
RouteRangeOptions	setStartingPoint(com.azure.core.models.GeoPosition startingPoint)	Sets the starting point.
RouteRangeOptions	setTimeBudgetInSec(Duration timeBudgetInSec)	Sets the time budget in seconds.

Methods inherited from class com.azure.maps.route.models.BaseRouteOptions

getAccelerationEfficiency, getAuxiliaryPowerInKw, getAuxiliaryPowerInLitersPerHour, getAvoidRouteTypes, getConstantSpeedConsumptionInKwHPerHundredKm, getConstantSpeedConsumptionInLitersPerHundredKm, getCurrentChargeInKwH, getCurrentFuelInLiters, getDecelerationEfficiency, getDepartAt, getDownhillEfficiency, getFuelEnergyDensityInMegajoulesPerLiter, getInclineLevel, getMaxChargeInKwH, getRouteType, getTravelMode, getUphillEfficiency, getVehicleAxleWeight, getVehicleEngineType, getVehicleHeight, getVehicleLength, getVehicleLoadType, getVehicleMaxSpeed, getVehicleWeight, getVehicleWidth, getWindingness, isCommercialVehicle, isGetUseTrafficData, setAccelerationEfficiency, setAuxiliaryPowerInKw, setAuxiliaryPowerInLitersPerHour, setAvoid, setCommercialVehicle, setConstantSpeedConsumptionInKwHPerHundredKm, setConstantSpeedConsumptionInLitersPerHundredKm, setCurrentChargeInKwH, setCurrentFuelInLiters, setDecelerationEfficiency, setDepartAt, setDownhillEfficiency, setFuelEnergyDensityInMegajoulesPerLiter, setInclineLevel, setMaxChargeInKwH, setRouteType, setTravelMode, setUphillEfficiency, setUseTrafficData, setVehicleAxleWeight, setVehicleEngineType, setVehicleHeight, setVehicleLength, setVehicleLoadType, setVehicleMaxSpeed, setVehicleWeight, setVehicleWidth, setWindingness

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RouteRangeOptions

public RouteRangeOptions(com.azure.core.models.GeoPosition startingPoint,
 Duration timeBudgetInSec)

Builds a new RouteRangeOptions.

Parameters:

startingPoint - the starting point of the route as a GeoPosition

timeBudgetInSec - the time budget of this route.

RouteRangeOptions

public RouteRangeOptions(com.azure.core.models.GeoPosition startingPoint)

Builds a new RouteRangeOptions.

Parameters:

startingPoint - the starting point of the route as a GeoPosition

Method Details

getStartingPoint

public com.azure.core.models.GeoPosition getStartingPoint()

Returns the starting point.

Returns:

the starting point

getFuelBudgetInLiters

public Double getFuelBudgetInLiters()

Returns the fuel budget in liters.

Returns:

the fuel budget.

getEnergyBudgetInKwH

public Double getEnergyBudgetInKwH()

Returns the energy budget in KwH.

Returns:

the energy budget

getTimeBudgetInSec

public Duration getTimeBudgetInSec()

Returns the time budget in seconds.

Returns:

time budget in seconds.

getDistanceBudgetInMeters

public Double getDistanceBudgetInMeters()

Returns the distance budget in meters.

Returns:

distance budget.

setStartingPoint

public RouteRangeOptions setStartingPoint(com.azure.core.models.GeoPosition startingPoint)

Sets the starting point.

Parameters:

startingPoint - a GeoPosition representing the starting point of this route.

Returns:

a reference to this RouteRangeOptions

setFuelBudgetInLiters

public RouteRangeOptions setFuelBudgetInLiters(Double fuelBudgetInLiters)

Sets the fuel budget in liters.

Parameters:

fuelBudgetInLiters - the fuel budget.

Returns:

a reference to this RouteRangeOptions

setEnergyBudgetInKwH

public RouteRangeOptions setEnergyBudgetInKwH(Double energyBudgetInKwH)

Sets the energy budget in KwH

Parameters:

energyBudgetInKwH - the energy budget

Returns:

a reference to this RouteRangeOptions

setTimeBudgetInSec

public RouteRangeOptions setTimeBudgetInSec(Duration timeBudgetInSec)

Sets the time budget in seconds.

Parameters:

timeBudgetInSec - the time budget

Returns:

a reference to this RouteRangeOptions

setDistanceBudgetInMeters

public RouteRangeOptions setDistanceBudgetInMeters(Double distanceBudgetInMeters)

Sets the distance budget in meters.

Parameters:

distanceBudgetInMeters - the distance budget.

Returns:

a reference to this RouteRangeOptions