Struct TimeSliceInfo

pub struct TimeSliceInfo {
    pub times_of_day: IndexSet<TimeOfDay>,
    pub seasons: IndexMap<Season, Dimensionless>,
    pub time_slices: IndexMap<TimeSliceID, Dimensionless>,
}

Information about the time slices in the simulation, including names and fractions

Fields

times_of_day: IndexSet<TimeOfDay>

Names of times of day (e.g. “evening”)

seasons: IndexMap<Season, Dimensionless>

Names and fraction of year occupied by each season

time_slices: IndexMap<TimeSliceID, Dimensionless>

The fraction of the year that this combination of season and time of day occupies

Implementations

impl TimeSliceInfo

pub fn get_time_slice_id_from_str( &self, time_slice: &str, ) -> Result<TimeSliceID>

Get the TimeSliceID corresponding to the time_slice.

time_slice must be in the form “season.time_of_day”.

pub fn get_selection(&self, time_slice: &str) -> Result<TimeSliceSelection>

Get a TimeSliceSelection from the specified string.

If the string is empty, the default value is TimeSliceSelection::Annual.

pub fn iter_ids(&self) -> Keys<'_, TimeSliceID, Dimensionless>

Iterate over all TimeSliceIDs

pub fn iter(&self) -> impl Iterator<Item = (&TimeSliceID, Dimensionless)>

Iterate over all time slices

pub fn iter_selections_at_level( &self, level: TimeSliceLevel, ) -> Box<dyn Iterator<Item = TimeSliceSelection> + '_>

Iterate over the different time slice selections for a given time slice level.

For example, if TimeSliceLevel::Season is specified, this function will return an iterator of TimeSliceSelections covering each season.

pub fn iter_selection_share<'a>( &'a self, selection: &'a TimeSliceSelection, level: TimeSliceLevel, ) -> Option<impl Iterator<Item = (TimeSliceSelection, Dimensionless)>>

Iterate over a subset of time slices calculating the relative duration of each.

The relative duration is specified as a fraction of the total time (proportion of year) covered by selection.

Arguments

• selection - A subset of time slices

Returns

An iterator of time slices along with the fraction of the total selection.

pub fn calculate_share<'a>( &'a self, selection: &'a TimeSliceSelection, level: TimeSliceLevel, value: Dimensionless, ) -> Option<impl Iterator<Item = (TimeSliceSelection, Dimensionless)>>

Share a value between a subset of time slices in proportion to their lengths.

For instance, you could use this function to compute how demand is distributed between the different time slices of winter.

Arguments

• selection - A subset of time slices
• value - The value to be shared between the time slices

Returns

An iterator of time slices along with a fraction of value.

Trait Implementations

impl Debug for TimeSliceInfo

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

Formats the value using the given formatter.

impl Default for TimeSliceInfo

fn default() -> Self

The default TimeSliceInfo is a single time slice covering the whole year

impl PartialEq for TimeSliceInfo

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