Managing Controls

Enumerations
enum	EN_ControlType { EN_LOWLEVEL = 0, EN_HILEVEL = 1, EN_TIMER = 2, EN_TIMEOFDAY = 3 }

Functions
int	ENgetcontrol (int controlIndex, int *controlType, int *linkIndex, EN_API_FLOAT_TYPE *setting, int *nodeIndex, EN_API_FLOAT_TYPE *level)
	Retrieves parameters that define a simple control. More...
int	ENsetcontrol (int cindex, int ctype, int lindex, EN_API_FLOAT_TYPE setting, int nindex, EN_API_FLOAT_TYPE level)
	Specify parameters to define a simple control. More...

Detailed Description

Function Documentation

int ENgetcontrol	(	int	controlIndex,
		int *	controlType,
		int *	linkIndex,
		EN_API_FLOAT_TYPE *	setting,
		int *	nodeIndex,
		EN_API_FLOAT_TYPE *	level
	)

Retrieves parameters that define a simple control.

Parameters

	controlIndex	Control index (position of control statement in the input file, starting from 1)
[out]	controlType	Control type code (see EPANET2.H)
[out]	linkIndex	Index of controlled link
[out]	setting	Control setting on link
[out]	nodeIndex	Index of controlling node (0 for TIMER or TIMEOFDAY control)
[out]	level	Control level (tank level, junction pressure, or time (seconds))

Returns

Error code

int ENsetcontrol	(	int	cindex,
		int	ctype,
		int	lindex,
		EN_API_FLOAT_TYPE	setting,
		int	nindex,
		EN_API_FLOAT_TYPE	level
	)

Specify parameters to define a simple control.

Parameters

cindex	The index of the control to edit. First control is index 1.
ctype	The type code to set for this control.
lindex	The index of a link to control.
setting	The control setting applied to the link.
nindex	The index of a node used to control the link, or 0 for TIMER / TIMEOFDAY control.
level	control point (tank level, junction pressure, or time in seconds).

Returns

Error code.