Class ShipmentRoute.Types.Visit

A visit performed during a route. This visit corresponds to a pickup or a delivery of a Shipment.

Inheritance

object

ShipmentRoute.Types.Visit

Implements

IMessage<ShipmentRoute.Types.Visit>

IEquatable<ShipmentRoute.Types.Visit>

IDeepCloneable<ShipmentRoute.Types.Visit>

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 ShipmentRoute.Types.Visit : IMessage<ShipmentRoute.Types.Visit>, IEquatable<ShipmentRoute.Types.Visit>, IDeepCloneable<ShipmentRoute.Types.Visit>, IBufferMessage, IMessage

Constructors

Visit()

Declaration

public Visit()

Visit(Visit)

Declaration

public Visit(ShipmentRoute.Types.Visit other)

Parameters

Type	Name	Description
ShipmentRoute.Types.Visit	other

Properties

Detour

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.

Declaration

public Duration Detour { get; set; }

Property Value

Type	Description
Duration

IsPickup

If true the visit corresponds to a pickup of a Shipment. Otherwise, it corresponds to a delivery.

Declaration

public bool IsPickup { get; set; }

Property Value

Type	Description
bool

LoadDemands

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.maps.routeoptimization.v1.ShipmentRoute.Transition] (see this field).

Declaration

public MapField<string, Shipment.Types.Load> LoadDemands { get; }

Property Value

Type	Description
MapField<string, Shipment.Types.Load>

ShipmentIndex

Index of the shipments field in the source [ShipmentModel][google.maps.routeoptimization.v1.ShipmentModel].

Declaration

public int ShipmentIndex { get; set; }

Property Value

Type	Description
int

ShipmentLabel

Copy of the corresponding Shipment.label, if specified in the Shipment.

Declaration

public string ShipmentLabel { get; set; }

Property Value

Type	Description
string

StartTime

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.

Declaration

public Timestamp StartTime { get; set; }

Property Value

Type	Description
Timestamp

VisitLabel

Copy of the corresponding [VisitRequest.label][google.maps.routeoptimization.v1.Shipment.VisitRequest.label], if specified in the VisitRequest.

Declaration

public string VisitLabel { get; set; }

Property Value

Type	Description
string

VisitRequestIndex

Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup).

Declaration

public int VisitRequestIndex { get; set; }

Property Value

Type	Description
int