Struct DurationLimit 

#[non_exhaustive]
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>,
    /* private fields */
}

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

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 new() -> Self

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

where T: Into<Duration>,

Sets the value of max_duration.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of max_duration.

Example

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

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

where T: Into<Duration>,

Sets the value of soft_max_duration.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of soft_max_duration.

Example

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

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

where T: Into<f64>,

Sets the value of cost_per_hour_after_soft_max.

Example

let x = DurationLimit::new().set_cost_per_hour_after_soft_max(42.0);

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

where T: Into<f64>,

Sets or clears the value of cost_per_hour_after_soft_max.

Example

let x = DurationLimit::new().set_or_clear_cost_per_hour_after_soft_max(Some(42.0));
let x = DurationLimit::new().set_or_clear_cost_per_hour_after_soft_max(None::<f32>);

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

where T: Into<Duration>,

Sets the value of quadratic_soft_max_duration.

Example

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

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

where T: Into<Duration>,

Sets or clears the value of quadratic_soft_max_duration.

Example

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

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

where T: Into<f64>,

Sets the value of cost_per_square_hour_after_quadratic_soft_max.

Example

let x = DurationLimit::new().set_cost_per_square_hour_after_quadratic_soft_max(42.0);

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

where T: Into<f64>,

Sets or clears the value of cost_per_square_hour_after_quadratic_soft_max.

Example

let x = DurationLimit::new().set_or_clear_cost_per_square_hour_after_quadratic_soft_max(Some(42.0));
let x = DurationLimit::new().set_or_clear_cost_per_square_hour_after_quadratic_soft_max(None::<f32>);

Trait Implementations

impl Clone for DurationLimit

fn clone(&self) -> DurationLimit

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

Returns the “default value” for a type.

impl Message for DurationLimit

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DurationLimit

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