Struct AssetRef

pub struct AssetRef(Rc<Asset>);

A wrapper around Asset for storing references in maps.

If the asset has been commissioned, then comparison and hashing is done based on the asset ID, otherwise a combination of other parameters is used.

Ord is implemented for AssetRef, but it will panic for non-commissioned assets.

Tuple Fields

0: Rc<Asset>

Implementations

impl AssetRef

pub fn make_mut(&mut self) -> &mut Asset

Make a mutable reference to the underlying Asset

Methods from Deref<Target = Asset>

pub fn state(&self) -> &AssetState

Get the state of this asset

pub fn process_parameter(&self) -> &ProcessParameter

The process parameter for this asset

pub fn max_decommission_year(&self) -> u32

The last year in which this asset should be decommissioned

pub fn get_activity_limits( &self, time_slice: &TimeSliceID, ) -> RangeInclusive<Activity>

Get the activity limits for this asset in a particular time slice

pub fn get_activity_per_capacity_limits( &self, time_slice: &TimeSliceID, ) -> RangeInclusive<ActivityPerCapacity>

Get the activity limits per unit of capacity for this asset in a particular time slice

pub fn get_operating_cost( &self, year: u32, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the operating cost for this asset in a given year and time slice

pub fn get_input_cost_from_prices( &self, input_prices: &HashMap<(CommodityID, RegionID, TimeSliceID), MoneyPerFlow>, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the cost of input flows using the commodity prices in input_prices

pub fn max_activity(&self) -> Activity

Maximum activity for this asset

pub fn get_flow(&self, commodity_id: &CommodityID) -> Option<&ProcessFlow>

Get a specific process flow

fn get_flows_map(&self) -> &IndexMap<CommodityID, ProcessFlow>

Get the process flows map for this asset

pub fn iter_flows(&self) -> impl Iterator<Item = &ProcessFlow>

Iterate over the asset’s flows

pub fn primary_output(&self) -> Option<&ProcessFlow>

Get the primary output flow (if any) for this asset

pub fn is_commissioned(&self) -> bool

Whether this asset has been commissioned

pub fn commission_year(&self) -> u32

Get the commission year for this asset

pub fn decommission_year(&self) -> Option<u32>

Get the decommission year for this asset

pub fn region_id(&self) -> &RegionID

Get the region ID for this asset

pub fn process(&self) -> &Process

Get the process for this asset

pub fn process_id(&self) -> &ProcessID

Get the process ID for this asset

pub fn id(&self) -> Option<AssetID>

Get the ID for this asset

pub fn agent_id(&self) -> Option<&AgentID>

Get the agent ID for this asset

pub fn capacity(&self) -> Capacity

Get the capacity for this asset

pub fn as_candidate(&self, capacity: Option<Capacity>) -> Asset

Creates a Candidate asset matching a given Commissioned asset

Optionally, the capacity can be set to a different value.

Trait Implementations

impl Clone for AssetRef

fn clone(&self) -> AssetRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetRef

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

Formats the value using the given formatter.

impl Deref for AssetRef

type Target = Asset

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Asset> for AssetRef

fn from(value: Asset) -> Self

Converts to this type from the input type.

impl From<AssetRef> for Rc<Asset>

fn from(value: AssetRef) -> Self

Converts to this type from the input type.

impl From<Rc<Asset>> for AssetRef

fn from(value: Rc<Asset>) -> Self

Converts to this type from the input type.

impl Hash for AssetRef

fn hash<H: Hasher>(&self, state: &mut H)

Hash an asset according to its state:

• Commissioned assets are hashed based on their ID alone
• Selected assets are hashed based on process_id, region_id, commission_year and agent_id
• Candidate assets are hashed based on process_id, region_id and commission_year
• Future and Decommissioned assets cannot currently be hashed

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AssetRef

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AssetRef

fn eq(&self, other: &Self) -> 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 PartialOrd for AssetRef

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for AssetRef