Package com.azure.maps.route.models

Class BaseRouteOptions<T extends BaseRouteOptions<T>>

java.lang.Object
com.azure.maps.route.models.BaseRouteOptions<T>
Direct Known Subclasses:
RouteDirectionsOptions, RouteRangeOptions
public abstract class BaseRouteOptions<T extends BaseRouteOptions<T>> extends Object
Base Route Options

  • Constructor Details

    • BaseRouteOptions

      public BaseRouteOptions()

  • Method Details

    • getConstantSpeedConsumptionInLitersPerHundredKm

      public String getConstantSpeedConsumptionInLitersPerHundredKm()
      Returns the constant speed fuel consumption.
      Returns:
      the constant speed fuel consumption.

    • getDepartAt

      public OffsetDateTime getDepartAt()
      Returns the departure time.
      Returns:
      the departure time.

    • getVehicleAxleWeight

      public Integer getVehicleAxleWeight()
      Returns the vehicle axle weight.
      Returns:
      the vehicle axle weight.

    • getVehicleWidth

      public Double getVehicleWidth()
      Returns the vehicle width in meters.
      Returns:
      the vehicle width.

    • getVehicleHeight

      public Double getVehicleHeight()
      Returns the vehicle height in meters.
      Returns:
      the vehicle height.

    • getVehicleLength

      public Double getVehicleLength()
      Returns the vehicle length in meters.
      Returns:
      the vehicle length.

    • getVehicleMaxSpeed

      public Integer getVehicleMaxSpeed()
      Returns the vehicle max speed.
      Returns:
      the vehicle max speed.

    • getVehicleWeight

      public Integer getVehicleWeight()
      Returns the vehicle weight.
      Returns:
      the vehicle weight.

    • isCommercialVehicle

      public Boolean isCommercialVehicle()
      Returns whether this is a commercial vehicle.
      Returns:
      whether this is a commercial vehicle.

    • getWindingness

      public WindingnessLevel getWindingness()
      Returns the windingness.
      Returns:
      WindingnessLevel

    • getInclineLevel

      public InclineLevel getInclineLevel()
      Return the incline level.
      Returns:
      InclineLevel

    • getTravelMode

      public TravelMode getTravelMode()
      Returns the travel mode.
      Returns:
      TravelMode

    • getAvoidRouteTypes

      public List<RouteAvoidType> getAvoidRouteTypes()
      Returns the list of route types to avoid.
      Returns:
      list of RouteAvoidTypes

    • isGetUseTrafficData

      public Boolean isGetUseTrafficData()
      Returns whether to use traffic data to calculate the route.
      Returns:
      whether to use traffic data.

    • getRouteType

      public RouteType getRouteType()
      Returns the type of route.
      Returns:
      RouteType.

    • getVehicleLoadType

      public VehicleLoadType getVehicleLoadType()
      Returns the vehicle load type.
      Returns:
      VehicleLoadType

    • getVehicleEngineType

      public VehicleEngineType getVehicleEngineType()
      Returns the vehicle engine type.
      Returns:
      VehicleEngineType

    • getCurrentFuelInLiters

      public Double getCurrentFuelInLiters()
      Returns the current fuel in liters.
      Returns:
      the current fuel in liters.

    • getAuxiliaryPowerInLitersPerHour

      public Double getAuxiliaryPowerInLitersPerHour()
      Returns the auxiliary power in liters per hour.
      Returns:
      the auxiliary power in liters per hour.

    • getFuelEnergyDensityInMegajoulesPerLiter

      public Double getFuelEnergyDensityInMegajoulesPerLiter()
      Returns the fuel energy density.
      Returns:
      the fuel energy density.

    • getAccelerationEfficiency

      public Double getAccelerationEfficiency()
      Returns the acceleration efficiency.
      Returns:
      the acceleration efficiency.

    • getDecelerationEfficiency

      public Double getDecelerationEfficiency()
      Returns the deceleration efficiency.
      Returns:
      the deceleration efficiency.

    • getUphillEfficiency

      public Double getUphillEfficiency()
      Returns the uphill efficiency.
      Returns:
      the uphill efficiency.

    • getDownhillEfficiency

      public Double getDownhillEfficiency()
      Returns the downhill efficiency.
      Returns:
      the downhill efficiency.

    • getConstantSpeedConsumptionInKwHPerHundredKm

      public String getConstantSpeedConsumptionInKwHPerHundredKm()
      Returns the constant speed energy consumption.
      Returns:
      the constant speed energy consumption.

    • getCurrentChargeInKwH

      public Double getCurrentChargeInKwH()
      Returns the current charge.
      Returns:
      the current charge.

    • getMaxChargeInKwH

      public Double getMaxChargeInKwH()
      Returns the max charge.
      Returns:
      the max charge.

    • getAuxiliaryPowerInKw

      public Double getAuxiliaryPowerInKw()
      Returns the auxiliary power.
      Returns:
      the auxiliary power.

    • setDepartAt

      public T setDepartAt(OffsetDateTime departAt)
      Sets the departure time.
      Parameters:
      departAt - the departure time.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleAxleWeight

      public T setVehicleAxleWeight(Integer vehicleAxleWeight)
      Sets the vehicle axle weight.
      Parameters:
      vehicleAxleWeight - the vehicle axle weight.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleWidth

      public T setVehicleWidth(Double vehicleWidth)
      Sets the vehicle width.
      Parameters:
      vehicleWidth - the vehicle width.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleHeight

      public T setVehicleHeight(Double vehicleHeight)
      Sets the vehicle height.
      Parameters:
      vehicleHeight - the vehicle height.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleLength

      public T setVehicleLength(Double vehicleLength)
      Sets the vehicle length.
      Parameters:
      vehicleLength - the vehicle length.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleMaxSpeed

      public T setVehicleMaxSpeed(Integer vehicleMaxSpeed)
      Sets the vehicle max speed.
      Parameters:
      vehicleMaxSpeed - the vehicle max speed.
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleWeight

      public T setVehicleWeight(Integer vehicleWeight)
      Sets the vehicle weight.
      Parameters:
      vehicleWeight - the vehicle weight.
      Returns:
      a reference to this BaseRouteOptions

    • setCommercialVehicle

      public T setCommercialVehicle(Boolean isCommercialVehicle)
      Sets whether this is a commercial vehicle.
      Parameters:
      isCommercialVehicle - whether this is a commercial vehicle.
      Returns:
      a reference to this BaseRouteOptions

    • setWindingness

      public T setWindingness(WindingnessLevel windingness)
      Sets the windingness.
      Parameters:
      windingness - WindingnessLevel
      Returns:
      a reference to this BaseRouteOptions

    • setInclineLevel

      public T setInclineLevel(InclineLevel inclineLevel)
      Sets the incline level.
      Parameters:
      inclineLevel - InclineLevel
      Returns:
      a reference to this BaseRouteOptions

    • setTravelMode

      public T setTravelMode(TravelMode travelMode)
      Sets the travel mode.
      Parameters:
      travelMode - TravelMode
      Returns:
      a reference to this BaseRouteOptions

    • setAvoid

      public T setAvoid(List<RouteAvoidType> avoid)
      Sets the list of route types to avoid.
      Parameters:
      avoid - list of RouteAvoidTypes
      Returns:
      a reference to this BaseRouteOptions

    • setUseTrafficData

      public T setUseTrafficData(Boolean useTrafficData)
      Sets whether to use traffic data to calculate the route.
      Parameters:
      useTrafficData - whether to use traffic data to calculate the route.
      Returns:
      a reference to this BaseRouteOptions

    • setRouteType

      public T setRouteType(RouteType routeType)
      Sets the type of route.
      Parameters:
      routeType - RouteType
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleLoadType

      public T setVehicleLoadType(VehicleLoadType vehicleLoadType)
      Sets the vehicle load type.
      Parameters:
      vehicleLoadType - VehicleLoadType
      Returns:
      a reference to this BaseRouteOptions

    • setVehicleEngineType

      public T setVehicleEngineType(VehicleEngineType vehicleEngineType)
      Sets the vehicle engine type.
      Parameters:
      vehicleEngineType - VehicleEngineType
      Returns:
      a reference to this BaseRouteOptions

    • setConstantSpeedConsumptionInLitersPerHundredKm

      public T setConstantSpeedConsumptionInLitersPerHundredKm(String constantSpeedConsumptionInLitersPerHundredKm)
      Sets the constant speed fuel consumption.
      Parameters:
      constantSpeedConsumptionInLitersPerHundredKm - the constant speed fuel consumption.
      Returns:
      a reference to this BaseRouteOptions

    • setCurrentFuelInLiters

      public T setCurrentFuelInLiters(Double currentFuelInLiters)
      Sets the current fuel in liters.
      Parameters:
      currentFuelInLiters - the current fuel in liters.
      Returns:
      a reference to this BaseRouteOptions

    • setAuxiliaryPowerInLitersPerHour

      public T setAuxiliaryPowerInLitersPerHour(Double auxiliaryPowerInLitersPerHour)
      Sets the auxiliary power in liters per hour.
      Parameters:
      auxiliaryPowerInLitersPerHour - the auxiliary power in liters per hour.
      Returns:
      a reference to this BaseRouteOptions

    • setFuelEnergyDensityInMegajoulesPerLiter

      public T setFuelEnergyDensityInMegajoulesPerLiter(Double fuelEnergyDensityInMegajoulesPerLiter)
      Sets the fuel energy density.
      Parameters:
      fuelEnergyDensityInMegajoulesPerLiter - the fuel energy density.
      Returns:
      a reference to this BaseRouteOptions

    • setAccelerationEfficiency

      public T setAccelerationEfficiency(Double accelerationEfficiency)
      Sets the acceleration efficiency.
      Parameters:
      accelerationEfficiency - the acceleration efficiency.
      Returns:
      a reference to this BaseRouteOptions

    • setDecelerationEfficiency

      public T setDecelerationEfficiency(Double decelerationEfficiency)
      Sets the deceleration efficiency.
      Parameters:
      decelerationEfficiency - the deceleration efficiency.
      Returns:
      a reference to this BaseRouteOptions

    • setUphillEfficiency

      public T setUphillEfficiency(Double uphillEfficiency)
      Sets the uphill efficiency.
      Parameters:
      uphillEfficiency - the uphill efficiency.
      Returns:
      a reference to this BaseRouteOptions

    • setDownhillEfficiency

      public T setDownhillEfficiency(Double downhillEfficiency)
      Sets the downhill efficiency.
      Parameters:
      downhillEfficiency - the downhill efficiency.
      Returns:
      a reference to this BaseRouteOptions

    • setConstantSpeedConsumptionInKwHPerHundredKm

      public T setConstantSpeedConsumptionInKwHPerHundredKm(String constantSpeedConsumptionInKwHPerHundredKm)
      Sets the constant speed energy consumption.
      Parameters:
      constantSpeedConsumptionInKwHPerHundredKm - the constant speed energy consumption.
      Returns:
      a reference to this BaseRouteOptions

    • setCurrentChargeInKwH

      public T setCurrentChargeInKwH(Double currentChargeInKwH)
      Sets the current charge.
      Parameters:
      currentChargeInKwH - the current charge.
      Returns:
      a reference to this BaseRouteOptions

    • setMaxChargeInKwH

      public T setMaxChargeInKwH(Double maxChargeInKwH)
      Sets the max charge.
      Parameters:
      maxChargeInKwH - the max charge.
      Returns:
      a reference to this BaseRouteOptions

    • setAuxiliaryPowerInKw

      public T setAuxiliaryPowerInKw(Double auxiliaryPowerInKw)
      Sets the auxiliary power.
      Parameters:
      auxiliaryPowerInKw - the auxiliary power.
      Returns:
      a reference to this BaseRouteOptions