public sealed class ShipmentRoute.Types.Visit : IMessage<ShipmentRoute.Types.Visit>, IEquatable<ShipmentRoute.Types.Visit>, IDeepCloneable<ShipmentRoute.Types.Visit>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Optimization v1 API class ShipmentRoute.Types.Visit.
A visit performed during a route. This visit corresponds to a pickup or a
delivery of a Shipment.
Implements
IMessageShipmentRouteTypesVisit, IEquatableShipmentRouteTypesVisit, IDeepCloneableShipmentRouteTypesVisit, IBufferMessage, IMessageNamespace
Google.Cloud.Optimization.V1Assembly
Google.Cloud.Optimization.V1.dll
Constructors
Visit()
public Visit()Visit(Visit)
public Visit(ShipmentRoute.Types.Visit other)| Parameter | |
|---|---|
| Name | Description |
other |
ShipmentRouteTypesVisit |
Properties
ArrivalLoads
[Obsolete]
public RepeatedField<CapacityQuantity> ArrivalLoads { get; }Deprecated: Use
[Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
instead. Vehicle loads upon arrival at the visit location, for each type
specified in
[Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
start_load_intervals, end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldCapacityQuantity |
|
DelayBeforeStart
[Obsolete]
public ShipmentRoute.Types.Delay DelayBeforeStart { get; set; }Deprecated: Use [ShipmentRoute.Transition.delay_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.delay_duration] instead. Delay occurring before the visit starts.
| Property Value | |
|---|---|
| Type | Description |
ShipmentRouteTypesDelay |
|
Demands
[Obsolete]
public RepeatedField<CapacityQuantity> Demands { get; }Deprecated: Use [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands] instead.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldCapacityQuantity |
|
Detour
public Duration Detour { get; set; }Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to:
start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).
Otherwise, it is computed from the vehicle start_location and is equal
to:
start_time - vehicle_start_time - travel duration from
the vehicle's `start_location` to the visit.
| Property Value | |
|---|---|
| Type | Description |
Duration |
|
IsPickup
public bool IsPickup { get; set; }If true the visit corresponds to a pickup of a Shipment. Otherwise, it
corresponds to a delivery.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
LoadDemands
public MapField<string, Shipment.Types.Load> LoadDemands { get; }Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
[Transition.loads][google.cloud.optimization.v1.ShipmentRoute.Transition]
(see this field).
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringShipmentTypesLoad |
|
ShipmentIndex
public int ShipmentIndex { get; set; }Index of the shipments field in the source
[ShipmentModel][google.cloud.optimization.v1.ShipmentModel].
| Property Value | |
|---|---|
| Type | Description |
int |
|
ShipmentLabel
public string ShipmentLabel { get; set; }Copy of the corresponding Shipment.label, if specified in the
Shipment.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StartTime
public Timestamp StartTime { get; set; }Time at which the visit starts. Note that the vehicle may arrive earlier
than this at the visit location. Times are consistent with the
ShipmentModel.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
VisitLabel
public string VisitLabel { get; set; }Copy of the corresponding
[VisitRequest.label][google.cloud.optimization.v1.Shipment.VisitRequest.label],
if specified in the VisitRequest.
| Property Value | |
|---|---|
| Type | Description |
string |
|
VisitRequestIndex
public int VisitRequestIndex { get; set; }Index of VisitRequest in either the pickup or delivery field of the
Shipment (see is_pickup).
| Property Value | |
|---|---|
| Type | Description |
int |
|