Parameter#

module wntr.msx.elements

class Parameter[source]#

Bases: VariableBase

Parameterized variable for use in expressions.

Parameters:

  • name (str) – Name of this parameter.

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

  • units – Units for this parameter, by default None

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

  • _vars – Reaction system this parameter is a part of, by default None

  • _vals – Network-specific values for this parameter, by default None

__init__(name, global_value, *, units=None, note=None, _vars=None, _vals=None)[source]#

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:
to_dict()[source]#

Dictionary representation of the object

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)

property var_type: VariableType#

Type of variable, PARAMETER.