Struct Visit 

#[non_exhaustive]
pub struct Visit {
    pub shipment_index: i32,
    pub is_pickup: bool,
    pub visit_request_index: i32,
    pub start_time: Option<Timestamp>,
    pub load_demands: HashMap<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>,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

shipment_index: i32

Index of the shipments field in the source 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: HashMap<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 (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, if specified in the VisitRequest.

arrival_loads: Vec<CapacityQuantity>

👎Deprecated

Deprecated: Use Transition.vehicle_loads instead. Vehicle loads upon arrival at the visit location, for each type specified in 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 instead. Delay occurring before the visit starts.

demands: Vec<CapacityQuantity>

👎Deprecated

Deprecated: Use Visit.load_demands instead.

Implementations

impl Visit

pub fn new() -> Self

Creates a new default instance.

pub fn set_shipment_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of shipment_index.

Example

let x = Visit::new().set_shipment_index(42);

pub fn set_is_pickup<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_pickup.

Example

let x = Visit::new().set_is_pickup(true);

pub fn set_visit_request_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of visit_request_index.

Example

let x = Visit::new().set_visit_request_index(42);

pub fn set_start_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of start_time.

Example

use wkt::Timestamp;
let x = Visit::new().set_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = Visit::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = Visit::new().set_or_clear_start_time(None::<Timestamp>);

pub fn set_load_demands<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Load>,

Sets the value of load_demands.

Example

use google_cloud_optimization_v1::model::shipment::Load;
let x = Visit::new().set_load_demands([
    ("key0", Load::default()/* use setters */),
    ("key1", Load::default()/* use (different) setters */),
]);

pub fn set_detour<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of detour.

Example

use wkt::Duration;
let x = Visit::new().set_detour(Duration::default()/* use setters */);

pub fn set_or_clear_detour<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of detour.

Example

use wkt::Duration;
let x = Visit::new().set_or_clear_detour(Some(Duration::default()/* use setters */));
let x = Visit::new().set_or_clear_detour(None::<Duration>);

pub fn set_shipment_label<T: Into<String>>(self, v: T) -> Self

Sets the value of shipment_label.

Example

let x = Visit::new().set_shipment_label("example");

pub fn set_visit_label<T: Into<String>>(self, v: T) -> Self

Sets the value of visit_label.

Example

let x = Visit::new().set_visit_label("example");

pub fn set_arrival_loads<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<CapacityQuantity>,

👎Deprecated

Sets the value of arrival_loads.

Example

use google_cloud_optimization_v1::model::CapacityQuantity;
let x = Visit::new()
    .set_arrival_loads([
        CapacityQuantity::default()/* use setters */,
        CapacityQuantity::default()/* use (different) setters */,
    ]);

pub fn set_delay_before_start<T>(self, v: T) -> Self

where T: Into<Delay>,

👎Deprecated

Sets the value of delay_before_start.

Example

use google_cloud_optimization_v1::model::shipment_route::Delay;
let x = Visit::new().set_delay_before_start(Delay::default()/* use setters */);

pub fn set_or_clear_delay_before_start<T>(self, v: Option<T>) -> Self

where T: Into<Delay>,

👎Deprecated

Sets or clears the value of delay_before_start.

Example

use google_cloud_optimization_v1::model::shipment_route::Delay;
let x = Visit::new().set_or_clear_delay_before_start(Some(Delay::default()/* use setters */));
let x = Visit::new().set_or_clear_delay_before_start(None::<Delay>);

pub fn set_demands<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<CapacityQuantity>,

👎Deprecated

Sets the value of demands.

Example

use google_cloud_optimization_v1::model::CapacityQuantity;
let x = Visit::new()
    .set_demands([
        CapacityQuantity::default()/* use setters */,
        CapacityQuantity::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Visit

fn clone(&self) -> Visit

Returns a duplicate 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() -> Visit

Returns the “default value” for a type.

impl Message for Visit

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Visit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Visit