Struct Commodity 

pub struct Commodity {
    pub id: CommodityID,
    pub description: String,
    pub kind: CommodityType,
    pub time_slice_level: TimeSliceLevel,
    pub pricing_strategy: PricingStrategy,
    pub levies_prod: CommodityLevyMap,
    pub levies_cons: CommodityLevyMap,
    pub demand: DemandMap,
    pub constraints: CommodityConstraintsMap,
    pub units: String,
}

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

pricing_strategy: PricingStrategy

Defines the strategy used for calculating commodity prices

levies_prod: CommodityLevyMap

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

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

levies_cons: CommodityLevyMap

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

May be empty if there are no consumption 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).

constraints: CommodityConstraintsMap

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

May be empty if there are no constraints for this commodity, otherwise there must be entries for every combination of parameters.

units: String

Units for this commodity represented as a string e.g Petajoules, Tonnes This is only used for validation purposes.

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 HasID<CommodityID> for Commodity

fn get_id(&self) -> &CommodityID

Get the struct’s ID

impl PartialEq for Commodity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Commodity