Struct Asset

pub struct Asset {
    state: AssetState,
    process: Rc<Process>,
    process_parameter: Rc<ProcessParameter>,
    region_id: RegionID,
    capacity: Capacity,
    commission_year: u32,
}

An asset controlled by an agent.

Fields

state: AssetState

The status of the asset

process: Rc<Process>

The Process that this asset corresponds to

process_parameter: Rc<ProcessParameter>

The ProcessParameter corresponding to the asset’s region and commission year

region_id: RegionID

The region in which the asset is located

capacity: Capacity

Capacity of asset (for candidates this is a hypothetical capacity which may be altered)

commission_year: u32

The year the asset was/will be commissioned

Implementations

impl Asset

pub fn new_candidate( process: Rc<Process>, region_id: RegionID, capacity: Capacity, commission_year: u32, ) -> Result<Self>

Create a new candidate asset

pub fn new_future( agent_id: AgentID, process: Rc<Process>, region_id: RegionID, capacity: Capacity, commission_year: u32, ) -> Result<Self>

Create a new future asset

fn new_with_state( state: AssetState, process: Rc<Process>, region_id: RegionID, capacity: Capacity, commission_year: u32, ) -> Result<Self>

Private helper to create an asset with the given state

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 set_capacity(&mut self, capacity: Capacity)

Set the capacity for this asset (only for Candidate assets)

pub fn increase_capacity(&mut self, capacity: Capacity)

Increase the capacity for this asset (only for Candidate assets)

fn decommission(&mut self, decommission_year: u32)

Decommission this asset

fn commission_future(&mut self, id: AssetID)

Commission a future asset

pub fn select_candidate_for_investment(&mut self, agent_id: AgentID)

Select a Candidate asset for investment, converting it to a Selected state

fn commission_selected(&mut self, id: AssetID)

Commission a selected asset and give ownership to the specified agent

At this point we also check that the capacity is valid (panics if not).

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 Asset

fn clone(&self) -> Asset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Asset

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

Formats the value using the given formatter.

impl From<Asset> for AssetRef

fn from(value: Asset) -> Self

Converts to this type from the input type.

impl PartialEq for Asset

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