Controls File Enumerations

Controls enumeration types. More...

Collaboration diagram for Controls File Enumerations:

Enumerations
enum	RuleState {   r_RULE ,   r_IF ,   r_AND ,   r_OR ,   r_THEN ,   r_ELSE ,   r_PRIORITY ,   r_VARIABLE ,   r_EXPRESSION ,   r_ERROR }
	Enumeration of rule interpreter states. More...
enum	RuleObject {   r_GAGE ,   r_NODE ,   r_LINK ,   r_CONDUIT ,   r_PUMP ,   r_ORIFICE ,   r_WEIR ,   r_OUTLET ,   r_SIMULATION }
	Enumeration of rule object types. More...
enum	RuleAttrib {   r_DEPTH ,   r_MAXDEPTH ,   r_HEAD ,   r_VOLUME ,   r_INFLOW ,   r_FLOW ,   r_FULLFLOW ,   r_FULLDEPTH ,   r_STATUS ,   r_SETTING ,   r_LENGTH ,   r_SLOPE ,   r_VELOCITY ,   r_TIMEOPEN ,   r_TIMECLOSED ,   r_TIME ,   r_DATE ,   r_CLOCKTIME ,   r_DAYOFYEAR ,   r_DAY ,   r_MONTH }
	Enumeration of rule attribute types. More...
enum	RuleRelation {   EQ ,   NE ,   LT ,   LE ,   GT ,   GE }
	Enumeration of rule relational operators. More...
enum	RuleSetting {   r_CURVE ,   r_TIMESERIES ,   r_PID ,   r_NUMERIC }
	Enumeration of rule setting types. More...

Detailed Description

Controls enumeration types.

Enumeration Type Documentation

RuleAttrib

enum RuleAttrib

Enumeration of rule attribute types.

Todo:

Might be useful to make all use same enum type and used in API to avoid duplication.

Enumerator
r_DEPTH	Depth.
r_MAXDEPTH	Maximum depth.
r_HEAD	Head.
r_VOLUME	Volume.
r_INFLOW	Inflow.
r_FLOW	Flow.
r_FULLFLOW	Full flow.
r_FULLDEPTH	Full depth.
r_STATUS	Status.
r_SETTING	Setting.
r_LENGTH	Length.
r_SLOPE	Slope.
r_VELOCITY	Velocity.
r_TIMEOPEN	Time open.
r_TIMECLOSED	Time closed.
r_TIME	Time.
r_DATE	Date.
r_CLOCKTIME	Clock time.
r_DAYOFYEAR	Day of year.
r_DAY	Day.
r_MONTH	Month.

RuleObject

enum RuleObject

Enumeration of rule object types.

Enumerator
r_GAGE	Rain gage.
r_NODE	Node.
r_LINK	Link.
r_CONDUIT	Conduit.
r_PUMP	Pump.
r_ORIFICE	Orifice.
r_WEIR	Weir.
r_OUTLET	Outlet.
r_SIMULATION	Simulation.

RuleRelation

enum RuleRelation

Enumeration of rule relational operators.

Enumerator
EQ	Equal.
NE	Not equal.
LT	Less than.
LE	Less than or equal.
GT	Greater than.
GE	Greater than or equal.

RuleSetting

enum RuleSetting

Enumeration of rule setting types.

Enumerator
r_CURVE	Curve.
r_TIMESERIES	Timeseries.
r_PID	PID.
r_NUMERIC	Numeric.

RuleState

enum RuleState

Enumeration of rule interpreter states.

Enumerator
r_RULE	Rule interpreter is idle.
r_IF	If clause.
r_AND	And clause.
r_OR	Or clause.
r_THEN	Then clause.
r_ELSE	Else clause.
r_PRIORITY	Priority of control rule.
r_VARIABLE	Variable definition.
r_EXPRESSION	Expression definition.
r_ERROR	Error.