Struct TimeWindow

pub struct TimeWindow {
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub soft_start_time: Option<Timestamp>,
    pub soft_end_time: Option<Timestamp>,
    pub cost_per_hour_before_soft_start_time: Option<f64>,
    pub cost_per_hour_after_soft_end_time: Option<f64>,
}

Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle.

Hard time window bounds, start_time and end_time, enforce the earliest and latest time of the event, such that start_time <= event_time <= end_time. The soft time window lower bound, soft_start_time, expresses a preference for the event to happen at or after soft_start_time by incurring a cost proportional to how long before soft_start_time the event occurs. The soft time window upper bound, soft_end_time, expresses a preference for the event to happen at or before soft_end_time by incurring a cost proportional to how long after soft_end_time the event occurs. start_time, end_time, soft_start_time and soft_end_time should be within the global time limits (see [ShipmentModel.global_start_time][google.maps.routeoptimization.v1.ShipmentModel.global_start_time] and [ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time]) and should respect:

   0 <= `start_time` <= `end_time` and
   0 <= `start_time` <= `soft_start_time` and
   0 <= `soft_end_time` <= `end_time`.

Fields

start_time: Option<Timestamp>

The hard time window start time. If unspecified it will be set to ShipmentModel.global_start_time.

end_time: Option<Timestamp>

The hard time window end time. If unspecified it will be set to ShipmentModel.global_end_time.

soft_start_time: Option<Timestamp>

The soft start time of the time window.

soft_end_time: Option<Timestamp>

The soft end time of the time window.

cost_per_hour_before_soft_start_time: Option<f64>

A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:

    max(0, soft_start_time - t.seconds)
                           * cost_per_hour_before_soft_start_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_start_time has been set.

cost_per_hour_after_soft_end_time: Option<f64>

A cost per hour added to other costs in the model if the event occurs after soft_end_time, computed as:

    max(0, t.seconds - soft_end_time.seconds)
                     * cost_per_hour_after_soft_end_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_end_time has been set.

Implementations

impl TimeWindow

pub fn cost_per_hour_before_soft_start_time(&self) -> f64

Returns the value of cost_per_hour_before_soft_start_time, or the default value if cost_per_hour_before_soft_start_time is unset.

pub fn cost_per_hour_after_soft_end_time(&self) -> f64

Returns the value of cost_per_hour_after_soft_end_time, or the default value if cost_per_hour_after_soft_end_time is unset.

Trait Implementations

impl Clone for TimeWindow

fn clone(&self) -> TimeWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeWindow

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

Formats the value using the given formatter.

impl Default for TimeWindow

fn default() -> Self

Returns the “default value” for a type.

impl Message for TimeWindow

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for TimeWindow

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for TimeWindow

impl StructuralPartialEq for TimeWindow