ReservedName

module wntr.msx.elements

class ReservedName

Bases: VariableBase

Reserved name that should not be used

Parameters:

• name (str) – Reserved name.

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

Raises:

KeyExistsError – If the name has already been registered

---

__init__(name, *, note=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()

Represent the object as a dictionary

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, RESERVED.