Parameter

module wntr.msx.elements

class Parameter

Bases: VariableBase

Parameterized variable for use in expressions.

Parameters:

• name (str) – Name of this parameter.

• global_value (float) – Global value for the parameter if otherwise unspecified.

• units (str) – Units for this parameter, by default None

• note (str | dict | wntr.epanet.util.ENcomment) – Supplementary information regarding this variable, by default None

• _vars (wntr.msx.base.ReactionSystemBase) – Reaction system this parameter is a part of, by default None

• _vals (wntr.msx.elements.ParameterValues) – Network-specific values for this parameter, by default None

---

__init__(name, global_value, *, units=None, note=None, _vars=None, _vals=None)

Variable ABC init method.

Make sure you call this method from your concrete subclass __init__ method:

super().__init__(name, note=note)

Parameters:

• name (str) – Name/symbol for the variable. Must be a valid MSX variable name

• note ((str | dict | ENcomment), optional keyword) – Supplementary information regarding this variable, by default None (see-also NoteType)

Raises:

• KeyExistsError – Name is already taken

• ValueError – Name is a reserved word

to_dict()

Dictionary representation of the object

global_value: float

name: str

Name/ID of this variable, must be a valid EPANET/MSX ID

note: str | dict | ENcomment

Optional note regarding the variable (see NoteType)

units: str

property var_type: VariableType

Type of variable, PARAMETER.