Enum Parameter 

pub enum Parameter {
    Core(CoreParameter),
    Custom(CustomParameter),
}

Variants

Core(CoreParameter)

Custom(CustomParameter)

Implementations

impl Parameter

pub fn name(&self) -> Option<&str>

Return the parameter’s name if it has one.

Not all parameters are required to have a name in Pywr. Inline parameters may be defined without a name.

pub fn node_references(&self) -> HashMap<&str, &str>

Return a map of attribute to node references.

pub fn parameters(&self) -> HashMap<&str, ParameterValueType<'_>>

Return a map of attribute to parameter values.

pub fn ty(&self) -> &str

Return the type of the parameter

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

Return any external resource paths referenced by this parameter

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

Update any external resource paths referenced by this parameter if they are in the provided map.

pub fn is_custom(&self) -> bool

Return true if this is a customer parameter.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Parameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.