ControlCondition
module wntr.network.controls
-
class ControlCondition[source]
Bases: object
A base class for control conditions
-
__init__()[source]
-
abstract evaluate()[source]
Check if the condition is satisfied.
- Returns:
check
- Return type:
bool
-
abstract requires()[source]
Returns a set of objects required to evaluate this condition
- Returns:
required_objects
- Return type:
OrderedSet of object
-
property backtrack
The amount of time by which the simulation should be backed up.
Should be updated by the evaluate method if appropriate.
- Returns:
backtrack
- Return type:
int
-
property name
Returns the string representation of the condition.
- Returns:
name
- Return type:
str
