Controls.hpp File Reference

Rule-based control evaluation, parsing and action arbitration. More...

#include <cstdint>
#include <vector>
#include <string>
#include <unordered_map>
#include "../core/StringCase.hpp"
#include "../math/MathExpr.hpp"

Include dependency graph for Controls.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	openswmm::controls::Premise
struct	openswmm::controls::Action
struct	openswmm::controls::PIDState
struct	openswmm::controls::NamedVariable
struct	openswmm::controls::Rule
struct	openswmm::controls::ParseError
	Diagnostic for the most recent parseRuleText() rejection. More...
class	openswmm::controls::ControlEngine
	Mutable compiled control rules and per-action PID history. Use one owning simulation thread. Rule/context edits, parsing and evaluation must be serialized. No method catches allocation failures or rolls back all preceding mutations on exception. Hydraulic quantities use project display units; serial dates/time comparisons use SWMM days unless stated otherwise. More...
struct	openswmm::controls::ControlEngine::PremiseSoA
	Pre-sorted premise index for batch evaluation. More...

Namespaces
namespace	openswmm
namespace	openswmm::controls

Enumerations
enum class	openswmm::controls::CompareOp : int {   openswmm::controls::EQ = 0 ,   openswmm::controls::NE = 1 ,   openswmm::controls::LT = 2 ,   openswmm::controls::LE = 3 ,   openswmm::controls::GT = 4 ,   openswmm::controls::GE = 5 }
enum class	openswmm::controls::LogicOp : int {   openswmm::controls::AND = 0 ,   openswmm::controls::OR = 1 }
enum class	openswmm::controls::ConditionVar : int {   openswmm::controls::NODE_DEPTH = 0 ,   openswmm::controls::NODE_MAXDEPTH = 1 ,   openswmm::controls::NODE_HEAD = 2 ,   openswmm::controls::NODE_VOLUME = 3 ,   openswmm::controls::NODE_INFLOW = 4 ,   openswmm::controls::LINK_FLOW = 10 ,   openswmm::controls::LINK_DEPTH = 11 ,   openswmm::controls::LINK_SETTING = 12 ,   openswmm::controls::LINK_STATUS = 13 ,   openswmm::controls::LINK_FULLFLOW = 14 ,   openswmm::controls::LINK_FULLDEPTH = 15 ,   openswmm::controls::LINK_VELOCITY = 16 ,   openswmm::controls::LINK_LENGTH = 17 ,   openswmm::controls::LINK_SLOPE = 18 ,   openswmm::controls::LINK_TIMEOPEN = 19 ,   openswmm::controls::LINK_TIMECLOSED = 20 ,   openswmm::controls::GAGE_RAIN = 30 ,   openswmm::controls::GAGE_RAIN_PAST = 31 ,   openswmm::controls::SIM_TIME = 40 ,   openswmm::controls::SIM_DATE = 41 ,   openswmm::controls::CLOCK_TIME = 42 ,   openswmm::controls::SIM_DAY = 43 ,   openswmm::controls::SIM_MONTH = 44 ,   openswmm::controls::SIM_DAYOFYEAR = 45 }
enum class	openswmm::controls::ActionType : int {   openswmm::controls::NUMERIC = 0 ,   openswmm::controls::CURVE = 1 ,   openswmm::controls::TIMESERIES = 2 ,   openswmm::controls::PID = 3 }

Detailed Description

Rule-based control evaluation, parsing and action arbitration.

Implements the following legacy controls.c capabilities:

• All condition variable types (node/link/gage/system attributes)
• All action types (direct, curve-based, timeseries-based, PID)
• Named variables and math expression evaluation
• Time-aware comparison with half-step tolerance
• Priority-based action deduplication
• Ordered AND/OR reduction over pre-evaluated premise values

Note

Legacy reference: src/legacy/engine/controls.c

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

Apache-2.0