MapsRoutingModelFactory.RouteLegSummary Method

  • Reference

Definition

Namespace:
Azure.Maps.Routing.Models
Assembly:
Azure.Maps.Routing.dll
Package:
Azure.Maps.Routing v1.0.0-beta.3
Source:
MapsRoutingModelFactory.cs

Initializes a new instance of RouteLegSummary.

public static Azure.Maps.Routing.Models.RouteLegSummary RouteLegSummary (int? lengthInMeters = default, int? travelTimeInSeconds = default, int? trafficDelayInSeconds = default, DateTimeOffset? departureTime = default, DateTimeOffset? arrivalTime = default, int? noTrafficTravelTimeInSeconds = default, int? historicTrafficTravelTimeInSeconds = default, int? liveTrafficIncidentsTravelTimeInSeconds = default, double? fuelConsumptionInLiters = default, double? batteryConsumptionInKwH = default);
static member RouteLegSummary : Nullable<int> * Nullable<int> * Nullable<int> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<double> * Nullable<double> -> Azure.Maps.Routing.Models.RouteLegSummary
Public Shared Function RouteLegSummary (Optional lengthInMeters As Nullable(Of Integer) = Nothing, Optional travelTimeInSeconds As Nullable(Of Integer) = Nothing, Optional trafficDelayInSeconds As Nullable(Of Integer) = Nothing, Optional departureTime As Nullable(Of DateTimeOffset) = Nothing, Optional arrivalTime As Nullable(Of DateTimeOffset) = Nothing, Optional noTrafficTravelTimeInSeconds As Nullable(Of Integer) = Nothing, Optional historicTrafficTravelTimeInSeconds As Nullable(Of Integer) = Nothing, Optional liveTrafficIncidentsTravelTimeInSeconds As Nullable(Of Integer) = Nothing, Optional fuelConsumptionInLiters As Nullable(Of Double) = Nothing, Optional batteryConsumptionInKwH As Nullable(Of Double) = Nothing) As RouteLegSummary

Parameters

lengthInMeters
Nullable<Int32>

Length In Meters property.

travelTimeInSeconds
Nullable<Int32>

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.

trafficDelayInSeconds
Nullable<Int32>

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.

departureTime
Nullable<DateTimeOffset>

The estimated departure time for the route or leg. Time is in UTC.

arrivalTime
Nullable<DateTimeOffset>

The estimated arrival time for the route or leg. Time is in UTC.

noTrafficTravelTimeInSeconds
Nullable<Int32>

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.

historicTrafficTravelTimeInSeconds
Nullable<Int32>

Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.

liveTrafficIncidentsTravelTimeInSeconds
Nullable<Int32>

Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.

fuelConsumptionInLiters
Nullable<Double>

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.

batteryConsumptionInKwH
Nullable<Double>

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

RouteLegSummary

A new RouteLegSummary instance for mocking.

Applies to