Struct google_api_proto::google::cloud::optimization::v1::shipment_model::break_rule::FrequencyConstraint

pub struct FrequencyConstraint {
    pub min_break_duration: Option<Duration>,
    pub max_inter_break_duration: Option<Duration>,
}

One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as “There must be a break of at least 1 hour every 12 hours”. Assuming that this can be interpreted as “Within any sliding time window of 12h, there must be at least one break of at least one hour”, that example would translate to the following FrequencyConstraint:

{
    min_break_duration { seconds: 3600 }         # 1 hour.
    max_inter_break_duration { seconds: 39600 }  # 11 hours (12 - 1 = 11).
}

The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the BreakRequest.

A FrequencyConstraint may in practice apply to non-consecutive breaks. For example, the following schedule honors the “1h every 12h” example:

   04:00 vehicle start
    .. performing travel and visits ..
   09:00 1 hour break
   10:00 end of the break
    .. performing travel and visits ..
   12:00 20-min lunch break
   12:20 end of the break
    .. performing travel and visits ..
   21:00 1 hour break
   22:00 end of the break
    .. performing travel and visits ..
   23:59 vehicle end

Fields

min_break_duration: Option<Duration>

Required. Minimum break duration for this constraint. Nonnegative. See description of FrequencyConstraint.

max_inter_break_duration: Option<Duration>

Required. Maximum allowed span of any interval of time in the route that does not include at least partially a break of duration >= min_break_duration. Must be positive.

Trait Implementations

impl Clone for FrequencyConstraint

fn clone(&self) -> FrequencyConstraint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyConstraint

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

Formats the value using the given formatter.

impl Default for FrequencyConstraint

fn default() -> Self

Returns the “default value” for a type.

impl Message for FrequencyConstraint

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 FrequencyConstraint

fn eq(&self, other: &FrequencyConstraint) -> 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 Copy for FrequencyConstraint

impl StructuralPartialEq for FrequencyConstraint