Show / Hide Table of Contents

Class VehicleFullness

[VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] is a metric which computes how full a vehicle is. Each [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] field is between 0 and 1, computed as the ratio between a capped metric field (e.g. [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters]) and its related vehicle limit (e.g. [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]), if it exists. Otherwise the fullness ratio stays unset. If the limit is 0, the field is set to 1. Note: when a route is subject to traffic infeasibilities, some raw fullness ratios might exceed 1.0, e.g. the vehicle might exceed its distance limit. In these cases, we cap the fullness values at 1.0.

Inheritance
object
VehicleFullness
Implements
IMessage<VehicleFullness>
IEquatable<VehicleFullness>
IDeepCloneable<VehicleFullness>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Maps.RouteOptimization.V1
Assembly: Google.Maps.RouteOptimization.V1.dll
Syntax
public sealed class VehicleFullness : IMessage<VehicleFullness>, IEquatable<VehicleFullness>, IDeepCloneable<VehicleFullness>, IBufferMessage, IMessage

Constructors

VehicleFullness()

Declaration
public VehicleFullness()

VehicleFullness(VehicleFullness)

Declaration
public VehicleFullness(VehicleFullness other)
Parameters
Type Name Description
VehicleFullness other

Properties

ActiveDuration

The ratio between [AggregatedMetrics.total_duration_seconds][] and [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit]. If [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit] is unset, this field will be unset.

Declaration
public double ActiveDuration { get; set; }
Property Value
Type Description
double

ActiveSpan

The ratio (vehicle_end_time - vehicle_start_time) / (latest_vehicle_end_time - earliest_vehicle_start_time) for a given vehicle. If the denominator is not present, it uses ([ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time]

[ShipmentModel.global_start_time][google.maps.routeoptimization.v1.ShipmentModel.global_start_time]) instead.

Declaration
public double ActiveSpan { get; set; }
Property Value
Type Description
double

Distance

The ratio between [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters] and [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]. If [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit] is unset, this field will be unset.

Declaration
public double Distance { get; set; }
Property Value
Type Description
double

HasActiveDuration

Gets whether the "active_duration" field is set

Declaration
public bool HasActiveDuration { get; }
Property Value
Type Description
bool

HasActiveSpan

Gets whether the "active_span" field is set

Declaration
public bool HasActiveSpan { get; }
Property Value
Type Description
bool

HasDistance

Gets whether the "distance" field is set

Declaration
public bool HasDistance { get; }
Property Value
Type Description
bool

HasMaxFullness

Gets whether the "max_fullness" field is set

Declaration
public bool HasMaxFullness { get; }
Property Value
Type Description
bool

HasMaxLoad

Gets whether the "max_load" field is set

Declaration
public bool HasMaxLoad { get; }
Property Value
Type Description
bool

HasTravelDuration

Gets whether the "travel_duration" field is set

Declaration
public bool HasTravelDuration { get; }
Property Value
Type Description
bool

MaxFullness

Maximum of all other fields in this message.

Declaration
public double MaxFullness { get; set; }
Property Value
Type Description
double

MaxLoad

The maximum ratio among all types of [AggregatedMetrics.max_load][] and their respective [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits]. If all [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits] fields are unset, this field will be unset.

Declaration
public double MaxLoad { get; set; }
Property Value
Type Description
double

TravelDuration

The ratio between [AggregatedMetrics.travel_duration_seconds][] and [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit]. If [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit] is unset, this field will be unset.

Declaration
public double TravelDuration { get; set; }
Property Value
Type Description
double
In this article
Back to top Generated by DocFX