Struct Commodity

pub struct Commodity {
    pub id: CommodityID,
    pub description: String,
    pub kind: CommodityType,
    pub time_slice_level: TimeSliceLevel,
    pub levies: CommodityLevyMap,
    pub demand: DemandMap,
}

A commodity within the simulation.

Represents a substance (e.g. CO2) or form of energy (e.g. electricity) that can be produced or consumed by processes.

Fields

id: CommodityID

Unique identifier for the commodity (e.g. “ELC”)

description: String

Text description of commodity (e.g. “electricity”)

kind: CommodityType

Commodity balance type

time_slice_level: TimeSliceLevel

The time slice level for commodity balance

levies: CommodityLevyMap

Levies for this commodity for different combinations of region, year and time slice.

May be empty if there are no levies for this commodity, otherwise there must be entries for every combination of parameters. Note that these values can be negative, indicating an incentive.

demand: DemandMap

Demand as defined in input files. Will be empty for non-service-demand commodities.

The TimeSliceSelection part of the key is always at the same TimeSliceLevel as the time_slice_level field. E.g. if the time_slice_level is seasonal, then there will be keys representing each season (and not e.g. individual time slices).

Trait Implementations

impl Clone for Commodity

fn clone(&self) -> Commodity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Commodity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Commodity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasID<CommodityID> for Commodity

fn get_id(&self) -> &CommodityID

Get the struct’s ID

impl PartialEq for Commodity

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