Enum AssetState 

pub enum AssetState {
    Commissioned {
        id: AssetID,
        agent_id: AgentID,
        mothballed_year: Option<u32>,
        parent: Option<AssetRef>,
    },
    Decommissioned {
        id: AssetID,
        agent_id: AgentID,
        decommission_year: u32,
    },
    Future {
        agent_id: AgentID,
    },
    Selected {
        agent_id: AgentID,
    },
    Parent {
        agent_id: AgentID,
        group_id: AssetGroupID,
    },
    Candidate,
}

The state of an asset

New assets are created as either Future or Candidate assets. Future assets (which are specified in the input data) have a fixed capacity and capital costs already accounted for, whereas Candidate assets capital costs are not yet accounted for, and their capacity is determined by the investment algorithm.

Future and Candidate assets can be converted to Commissioned assets by calling the commission method (or via pool operations that commission future/selected assets).

Commissioned assets can be decommissioned by calling decommission.

Variants

Commissioned

The asset has been commissioned

Fields

id: AssetID

The ID of the asset

agent_id: AgentID

The ID of the agent that owns the asset

mothballed_year: Option<u32>

Year in which the asset was mothballed. None, if it is not mothballed

parent: Option<AssetRef>

Parent asset, if any.

All divided assets have a parent, which tracks the total capacity across the children.

Decommissioned

The asset has been decommissioned

Fields

id: AssetID

The ID of the asset

agent_id: AgentID

The ID of the agent that owned the asset

decommission_year: u32

The year the asset was decommissioned

Future

The asset is planned for commissioning in the future

Fields

agent_id: AgentID

The ID of the agent that will own the asset

Selected

The asset has been selected for investment, but not yet confirmed

Fields

agent_id: AgentID

The ID of the agent that would own the asset

Parent

The asset is a parent of other assets.

Parents are used for grouping (commissioned) divided assets, which can be used as an optimisation.

Fields

agent_id: AgentID

The ID of the agent which owns this asset’s children

group_id: AssetGroupID

ID of the asset group

Candidate

The asset is a candidate for investment but has not yet been selected by an agent

Trait Implementations

impl Clone for AssetState

fn clone(&self) -> AssetState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetState

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

Formats the value using the given formatter.

impl Display for AssetState

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

Formats the value using the given formatter.

impl PartialEq for AssetState

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