Package com.azure.maps.route.models
Class RouteLegSummary
java.lang.Object
com.azure.maps.route.models.RouteLegSummary
Summary object for route section.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the arrivalTime property: The estimated arrival time for the route or leg.Get the batteryConsumptionInKwH property: Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model.Get the departureTime property: The estimated departure time for the route or leg.Get the fuelConsumptionInLiters property: Estimated fuel consumption in liters using the Combustion Consumption Model.Get the historicTrafficTravelTimeInSeconds property: Estimated travel time calculated using time-dependent historic traffic data.Get the lengthInMeters property: Length In Meters property.Get the liveTrafficIncidentsTravelTimeInSeconds property: Estimated travel time calculated using real-time speed data.Get the noTrafficTravelTimeInSeconds property: Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g.Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information.Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic.
-
Constructor Details
-
RouteLegSummary
public RouteLegSummary()
-
-
Method Details
-
getLengthInMeters
Get the lengthInMeters property: Length In Meters property.- Returns:
- the lengthInMeters value.
-
getTravelTimeInSeconds
Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.- Returns:
- the travelTimeInSeconds value.
-
getTrafficDelayInSeconds
Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.- Returns:
- the trafficDelayInSeconds value.
-
getDepartureTime
Get the departureTime property: The estimated departure time for the route or leg.- Returns:
- the departureTime value.
-
getArrivalTime
Get the arrivalTime property: The estimated arrival time for the route or leg.- Returns:
- the arrivalTime value.
-
getNoTrafficTravelTimeInSeconds
Get the noTrafficTravelTimeInSeconds property: Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query.- Returns:
- the noTrafficTravelTimeInSeconds value.
-
getHistoricTrafficTravelTimeInSeconds
Get the historicTrafficTravelTimeInSeconds property: Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.- Returns:
- the historicTrafficTravelTimeInSeconds value.
-
getLiveTrafficIncidentsTravelTimeInSeconds
Get the liveTrafficIncidentsTravelTimeInSeconds property: Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.- Returns:
- the liveTrafficIncidentsTravelTimeInSeconds value.
-
getFuelConsumptionInLiters
Get the fuelConsumptionInLiters property: Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to _combustion_ and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative.- Returns:
- the fuelConsumptionInLiters value.
-
getBatteryConsumptionInKwH
Get the batteryConsumptionInKwH property: Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation.- Returns:
- the batteryConsumptionInKwH value.
-