Reference documentation and code samples for the Google Maps Route Optimization V1 Client class VehicleFullness.
VehicleFullness is a metric which computes how full a vehicle is. Each VehicleFullness field is between 0 and 1, computed as the ratio between a capped metric field (e.g.
AggregatedMetrics.travel_distance_meters) and its related vehicle limit (e.g. 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.
Generated from protobuf message google.maps.routeoptimization.v1.VehicleFullness
Namespace
Google \ Maps \ RouteOptimization \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_fullness |
float
Maximum of all other fields in this message. |
↳ distance |
float
The ratio between AggregatedMetrics.travel_distance_meters and Vehicle.route_distance_limit. If Vehicle.route_distance_limit is unset, this field will be unset. |
↳ travel_duration |
float
The ratio between AggregatedMetrics.travel_duration_seconds and Vehicle.travel_duration_limit. If Vehicle.travel_duration_limit is unset, this field will be unset. |
↳ active_duration |
float
The ratio between AggregatedMetrics.total_duration_seconds and Vehicle.route_duration_limit. If Vehicle.route_duration_limit is unset, this field will be unset. |
↳ max_load |
float
The maximum ratio among all types of AggregatedMetrics.max_load and their respective Vehicle.load_limits. If all Vehicle.load_limits fields are unset, this field will be unset. |
↳ active_span |
float
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 - ShipmentModel.global_start_time) instead. |
getMaxFullness
Maximum of all other fields in this message.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasMaxFullness
clearMaxFullness
setMaxFullness
Maximum of all other fields in this message.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDistance
The ratio between AggregatedMetrics.travel_distance_meters and Vehicle.route_distance_limit.
If Vehicle.route_distance_limit is unset, this field will be unset.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasDistance
clearDistance
setDistance
The ratio between AggregatedMetrics.travel_distance_meters and Vehicle.route_distance_limit.
If Vehicle.route_distance_limit is unset, this field will be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTravelDuration
The ratio between AggregatedMetrics.travel_duration_seconds and Vehicle.travel_duration_limit.
If Vehicle.travel_duration_limit is unset, this field will be unset.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasTravelDuration
clearTravelDuration
setTravelDuration
The ratio between AggregatedMetrics.travel_duration_seconds and Vehicle.travel_duration_limit.
If Vehicle.travel_duration_limit is unset, this field will be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActiveDuration
The ratio between AggregatedMetrics.total_duration_seconds and Vehicle.route_duration_limit.
If Vehicle.route_duration_limit is unset, this field will be unset.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasActiveDuration
clearActiveDuration
setActiveDuration
The ratio between AggregatedMetrics.total_duration_seconds and Vehicle.route_duration_limit.
If Vehicle.route_duration_limit is unset, this field will be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxLoad
The maximum ratio among all types of AggregatedMetrics.max_load and their respective Vehicle.load_limits.
If all Vehicle.load_limits fields are unset, this field will be unset.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasMaxLoad
clearMaxLoad
setMaxLoad
The maximum ratio among all types of AggregatedMetrics.max_load and their respective Vehicle.load_limits.
If all Vehicle.load_limits fields are unset, this field will be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActiveSpan
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 - ShipmentModel.global_start_time) instead.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasActiveSpan
clearActiveSpan
setActiveSpan
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 - ShipmentModel.global_start_time) instead.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|