Struct TimeWindow 

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

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 and ShipmentModel.global_end_time) and should respect:

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

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.

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

Creates a new default instance.

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 = TimeWindow::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 = TimeWindow::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = TimeWindow::new().set_or_clear_start_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of soft_start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of soft_start_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of soft_end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of soft_end_time.

Example

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

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

where T: Into<f64>,

Sets the value of cost_per_hour_before_soft_start_time.

Example

let x = TimeWindow::new().set_cost_per_hour_before_soft_start_time(42.0);

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

where T: Into<f64>,

Sets or clears the value of cost_per_hour_before_soft_start_time.

Example

let x = TimeWindow::new().set_or_clear_cost_per_hour_before_soft_start_time(Some(42.0));
let x = TimeWindow::new().set_or_clear_cost_per_hour_before_soft_start_time(None::<f32>);

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

where T: Into<f64>,

Sets the value of cost_per_hour_after_soft_end_time.

Example

let x = TimeWindow::new().set_cost_per_hour_after_soft_end_time(42.0);

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

where T: Into<f64>,

Sets or clears the value of cost_per_hour_after_soft_end_time.

Example

let x = TimeWindow::new().set_or_clear_cost_per_hour_after_soft_end_time(Some(42.0));
let x = TimeWindow::new().set_or_clear_cost_per_hour_after_soft_end_time(None::<f32>);

Trait Implementations

impl Clone for TimeWindow

fn clone(&self) -> TimeWindow

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

Returns the “default value” for a type.

impl Message for TimeWindow

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TimeWindow

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TimeWindow