Struct google_api_proto::google::cloud::optimization::v1::vehicle::DurationLimit

pub struct DurationLimit {
    pub max_duration: Option<Duration>,
    pub soft_max_duration: Option<Duration>,
    pub cost_per_hour_after_soft_max: Option<f64>,
    pub quadratic_soft_max_duration: Option<Duration>,
    pub cost_per_square_hour_after_quadratic_soft_max: Option<f64>,
}

A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.

When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.

Fields

max_duration: Option<Duration>

A hard limit constraining the duration to be at most max_duration.

soft_max_duration: Option<Duration>

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

cost_per_hour_after_soft_max: Option<f64>

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

   cost_per_hour_after_soft_max * (duration - soft_max_duration)

The cost must be nonnegative.

quadratic_soft_max_duration: Option<Duration>

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

`max_duration - quadratic_soft_max_duration <= 86400 seconds`

cost_per_square_hour_after_quadratic_soft_max: Option<f64>

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

   cost_per_square_hour_after_quadratic_soft_max *
   (duration - quadratic_soft_max_duration)^2

The cost must be nonnegative.

Implementations

impl DurationLimit

pub fn cost_per_hour_after_soft_max(&self) -> f64

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

pub fn cost_per_square_hour_after_quadratic_soft_max(&self) -> f64

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

Trait Implementations

impl Clone for DurationLimit

fn clone(&self) -> DurationLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DurationLimit

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

Formats the value using the given formatter.

impl Default for DurationLimit

fn default() -> Self

Returns the “default value” for a type.

impl Message for DurationLimit

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 DurationLimit

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

impl StructuralPartialEq for DurationLimit