Struct google_api_proto::google::cloud::optimization::v1::shipment_route::Visit

pub struct Visit {
    pub shipment_index: i32,
    pub is_pickup: bool,
    pub visit_request_index: i32,
    pub start_time: Option<Timestamp>,
    pub load_demands: BTreeMap<String, Load>,
    pub detour: Option<Duration>,
    pub shipment_label: String,
    pub visit_label: String,
    pub arrival_loads: Vec<CapacityQuantity>,
    pub delay_before_start: Option<Delay>,
    pub demands: Vec<CapacityQuantity>,
}

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

Fields

shipment_index: i32

Index of the shipments field in the source [ShipmentModel][google.cloud.optimization.v1.ShipmentModel].

is_pickup: bool

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

visit_request_index: i32

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

start_time: Option<Timestamp>

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.

load_demands: BTreeMap<String, Load>

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).

detour: Option<Duration>

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.

shipment_label: String

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

visit_label: String

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

arrival_loads: Vec<CapacityQuantity>

👎Deprecated

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.

delay_before_start: Option<Delay>

👎Deprecated

Deprecated: Use [ShipmentRoute.Transition.delay_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.delay_duration] instead. Delay occurring before the visit starts.

demands: Vec<CapacityQuantity>

👎Deprecated

Deprecated: Use [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands] instead.

Trait Implementations

impl Clone for Visit

fn clone(&self) -> Visit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Visit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Visit

fn default() -> Self

Returns the “default value” for a type.

impl Message for Visit

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Visit

fn eq(&self, other: &Visit) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Visit