Struct PywrModel 

pub struct PywrModel {
    pub metadata: Metadata,
    pub timestepper: Timestepper,
    pub scenarios: Option<Vec<Scenario>>,
    pub network: PywrNetwork,
}

Fields

metadata: Metadata

timestepper: Timestepper

scenarios: Option<Vec<Scenario>>

network: PywrNetwork

Implementations

impl PywrModel

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, PywrSchemaError>

Load a PywrNetwork from a file path

pub fn get_node_by_name(&self, name: &str) -> Option<&Node>

Return a Node from its name. If no node with that name exists return None.

pub fn get_node_index_by_name(&self, name: &str) -> Option<usize>

Return a node’s index from its name. If no node with that name exists return None.

pub fn get_node(&self, idx: usize) -> Option<&Node>

Return a Node from its index. If no node with that name exists return None.

pub fn get_parameter_by_name(&self, name: &str) -> Option<&Parameter>

Return a Parameter from its name. If no node with that name exists return None.

pub fn get_parameter_index_by_name(&self, name: &str) -> Option<usize>

Return a parameter’s index from its name. If no parameter with that name exists return None.

pub fn get_parameter(&self, idx: usize) -> Option<&Parameter>

Return a Parameter from its index. If no parameter with that name exists return None.

pub fn resource_paths(&self) -> HashSet<PathBuf>

Return all of the model’s resource paths

pub fn node_resource_paths(&self) -> HashSet<PathBuf>

Return the model’s node resource paths

Note that this will include resource paths for any parameters defined inline within the nodes.

pub fn parameter_resource_paths(&self) -> HashSet<PathBuf>

Return the model’s parameter resource paths

pub fn table_resource_paths(&self) -> HashSet<PathBuf>

Return the model’s table resource paths

pub fn update_resource_paths(&mut self, new_paths: &HashMap<PathBuf, PathBuf>)

Update resource paths

Trait Implementations

impl Clone for PywrModel

fn clone(&self) -> PywrModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for PywrModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PywrModel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.