RouteLegSummary Class

Definition

Namespace:

Azure.Maps.Routing.Models

Assembly:

Azure.Maps.Routing.dll

Package:

Azure.Maps.Routing v1.0.0-beta.3

Source:

RouteLegSummary.cs

Summary object for route section.

public class RouteLegSummary

type RouteLegSummary = class

Public Class RouteLegSummary

Inheritance

Object

RouteLegSummary

Properties

ArrivalTime	The estimated arrival time for the route or leg. Time is in UTC.
BatteryConsumptionInKwH	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.
DepartureTime	The estimated departure time for the route or leg. Time is in UTC.
FuelConsumptionInLiters	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.
HistoricTrafficTravelTimeInSeconds	Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.
LengthInMeters	Length In Meters property.
LiveTrafficIncidentsTravelTimeInSeconds	Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.
NoTrafficTravelTimeInSeconds	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.
TrafficDelayInSeconds	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.
TravelTimeInSeconds	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.