JIANG/EPANET
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

migrating from defines to enums, and moving some documentation blocks into doxygen format

Browse Source
This commit is contained in:
Sam Hatchett
2015-11-25 19:26:47 -05:00
parent e484486915
commit e28f24af3c
2 changed files with 114 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
include/epanet2.h
View File

@@ -112,22 +112,25 @@ typedef enum {
EN_LINKPATTERN = 15 EN_LINKPATTERN = 15
} EN_LinkProperty; } EN_LinkProperty;
/// Time parameter codes
typedef enum {
EN_DURATION = 0,
EN_HYDSTEP = 1,
EN_QUALSTEP = 2,
EN_PATTERNSTEP = 3,
EN_PATTERNSTART = 4,
EN_REPORTSTEP = 5,
EN_REPORTSTART = 6,
EN_RULESTEP = 7,
EN_STATISTIC = 8,
EN_PERIODS = 9,
EN_STARTTIME = 10,
EN_HTIME = 11,
EN_QTIME = 12,
EN_HALTFLAG = 13,
EN_NEXTEVENT = 14
} EN_TimeProperty;
#define EN_DURATION 0 /* Time parameters */
#define EN_HYDSTEP 1
#define EN_QUALSTEP 2
#define EN_PATTERNSTEP 3
#define EN_PATTERNSTART 4
#define EN_REPORTSTEP 5
#define EN_REPORTSTART 6
#define EN_RULESTEP 7
#define EN_STATISTIC 8
#define EN_PERIODS 9
#define EN_STARTTIME 10 /* Added TNT 10/2/2009 */
#define EN_HTIME 11
#define EN_QTIME 12
#define EN_HALTFLAG 13
#define EN_NEXTEVENT 14
#define EN_ITERATIONS 0 #define EN_ITERATIONS 0
#define EN_RELATIVEERROR 1 #define EN_RELATIVEERROR 1
@@ -177,11 +180,15 @@ typedef enum {
#define EN_CMH 8 #define EN_CMH 8
#define EN_CMD 9 #define EN_CMD 9
#define EN_TRIALS 0 /* Misc. options */ /// Simulation Option codes
#define EN_ACCURACY 1 typedef enum {
#define EN_TOLERANCE 2 EN_TRIALS = 0,
#define EN_EMITEXPON 3 EN_ACCURACY = 1,
#define EN_DEMANDMULT 4 EN_TOLERANCE = 2,
EN_EMITEXPON = 3,
EN_DEMANDMULT = 4
} EN_Option;
#define EN_LOWLEVEL 0 /* Control types. */ #define EN_LOWLEVEL 0 /* Control types. */
#define EN_HILEVEL 1 /* See ControlType */ #define EN_HILEVEL 1 /* See ControlType */
@@ -593,54 +600,70 @@ extern "C" {
int DLLEXPORT ENgetdemandpattern(int nodeIndex, int demandIndex, int *pattIndex); int DLLEXPORT ENgetdemandpattern(int nodeIndex, int demandIndex, int *pattIndex);
/** /**
@brief @brief Get the index of a Link with specified ID.
@param @param id The string ID of a link.
@return @param[out] index The index of the named link (first link is index 1)
@return Error code
@see ENgetlinkid
*/ */
int DLLEXPORT ENgetlinkindex(char *id, int *index); int DLLEXPORT ENgetlinkindex(char *id, int *index);
/** /**
@brief @brief Get the string ID of a link with specified index
@param @param index The index of a link (first link is index 1)
@return @param[out] id The ID of the link. Up to MAXID characters will be copied, so id must be pre-allocated by the calling code to hold at least that many characters.
@return Error code
@see ENgetlinkindex
*/ */
int DLLEXPORT ENgetlinkid(int index, char *id); int DLLEXPORT ENgetlinkid(int index, char *id);
/** /**
@brief @brief Get the link type code for a specified link
@param @param index The index of a link (first link is index 1)
@return @param[out] code The type code of the link.
@return Error code
@see EN_LinkType @see EN_LinkType
*/ */
int DLLEXPORT ENgetlinktype(int index, int *code); int DLLEXPORT ENgetlinktype(int index, int *code);
/** /**
@brief @brief Get the indexes of a link's start- and end-nodes.
@param @param index The index of a link (first link is index 1)
@return @param[out] node1 The index of the link's start node (first node is index 1).
@param[out] node2 The index of the link's end node (first node is index 1).
@return Error code
@see ENgetnodeid, ENgetlinkid
*/ */
int DLLEXPORT ENgetlinknodes(int index, int *node1, int *node2); int DLLEXPORT ENgetlinknodes(int index, int *node1, int *node2);
/** /**
@brief @brief Get a property value for specified link.
@param @param index The index of a node (first node is index 1).
@return @param code The parameter desired.
@param[out] value The value of the link's specified property.
@return Error code
@see ENgetnodevalue, EN_LinkProperty
*/ */
int DLLEXPORT ENgetlinkvalue(int index, int code, EN_API_FLOAT_TYPE *value); int DLLEXPORT ENgetlinkvalue(int index, int code, EN_API_FLOAT_TYPE *value);
/** /**
@brief @brief Get a curve's properties.
@param @param curveIndex The index of a curve (first curve is index 1).
@return @param[out] id The curve's string ID. Client code must preallocate at least MAXID characters.
@param[out] nValues The number of values in the curve's (x,y) list.
@param[out] xValues The curve's x-values. Must be freed by client.
@param[out] yValues The curve's y-values. Must be freed by client.
@return Error code.
*/ */
int DLLEXPORT ENgetcurve(int curveIndex, char* id, int *nValues, EN_API_FLOAT_TYPE **xValues, EN_API_FLOAT_TYPE **yValues); int DLLEXPORT ENgetcurve(int curveIndex, char* id, int *nValues, EN_API_FLOAT_TYPE **xValues, EN_API_FLOAT_TYPE **yValues);
/** /**
@brief @brief Get the string ID of the head curve assigned to a pump.
@param @param linkIndex The index of a pump
@return @param[out] curveId The string ID of a curve. Must be preallocated by the client for at least MAXID characters.
@return Error code.
*/ */
int DLLEXPORT ENgetheadcurve(int, char *); int DLLEXPORT ENgetheadcurve(int linkIndex, char *curveId);
/** /**
@brief Get the type of pump @brief Get the type of pump
@@ -651,65 +674,86 @@ extern "C" {
int DLLEXPORT ENgetpumptype(int linkIndex, int *outType); int DLLEXPORT ENgetpumptype(int linkIndex, int *outType);
/** /**
@brief @brief Get the version number. This number is to be interpreted with implied decimals, i.e., "20100" == "2(.)01(.)00"
@param @param[out] version The version of EPANET
@return @return Error code.
*/ */
int DLLEXPORT ENgetversion(int *version); int DLLEXPORT ENgetversion(int *version);
/** /**
@brief @brief Specify parameters to define a simple control
@param @param cindex The index of the control to edit. First control is index 1.
@return @param ctype The type code to set for this control.
@param lindex The index of a link to control.
@param setting The control setting applied to the link.
@param nindex The index of a node used to control the link, or 0 for TIMER / TIMEOFDAY control.
@param level control point (tank level, junction pressure, or time in seconds).
@return Error code.
*/ */
int DLLEXPORT ENsetcontrol(int cindex, int ctype, int lindex, EN_API_FLOAT_TYPE setting, int nindex, EN_API_FLOAT_TYPE level); int DLLEXPORT ENsetcontrol(int cindex, int ctype, int lindex, EN_API_FLOAT_TYPE setting, int nindex, EN_API_FLOAT_TYPE level);
/** /**
@brief @brief Set a property value for a node.
@param @param index The index of a node. First node is index 1.
@return @param code The code for the proprty to set.
@param v The value to set for this node and property.
@return Error code.
@see EN_NodeProperty
*/ */
int DLLEXPORT ENsetnodevalue(int index, int code, EN_API_FLOAT_TYPE v); int DLLEXPORT ENsetnodevalue(int index, int code, EN_API_FLOAT_TYPE v);
/** /**
@brief @brief Set a proprty value for a link.
@param @param index The index of a link. First link is index 1.
@return @param code The code for the property to set.
@param v The value to set for this link and property.
@return Error code.
@see EN_LinkProperty
*/ */
int DLLEXPORT ENsetlinkvalue(int index, int code, EN_API_FLOAT_TYPE v); int DLLEXPORT ENsetlinkvalue(int index, int code, EN_API_FLOAT_TYPE v);
/** /**
@brief @brief Add a new time pattern.
@param @param id The string ID of the pattern to add.
@return @return Error code.
@see ENgetpatternindex
*/ */
int DLLEXPORT ENaddpattern(char *id); int DLLEXPORT ENaddpattern(char *id);
/** /**
@brief @brief Set multipliers for a specific pattern
@param @param index The index of a pattern. First pattern is index 1.
@return @param f An array of multipliers
@param len The length of array f.
@return Error code.
@see ENgetpatternindex
*/ */
int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *f, int len); int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *f, int len);
/** /**
@brief @brief Set the multiplier for a specific pattern at a specific period.
@param @param index The index of a pattern. First pattern is index 1.
@return @param period The period of the pattern to set.
@param value The value of the multiplier to set.
@return Error code.
*/ */
int DLLEXPORT ENsetpatternvalue(int index, int period, EN_API_FLOAT_TYPE value); int DLLEXPORT ENsetpatternvalue(int index, int period, EN_API_FLOAT_TYPE value);
/** /**
@brief @brief Set the value for a time parameter.
@param @param code The code for the parameter to set.
@return @param value The desired value of the parameter.
@return Error code.
@see EN_TimeProperty
*/ */
int DLLEXPORT ENsettimeparam(int code, long value); int DLLEXPORT ENsettimeparam(int code, long value);
/** /**
@brief @brief Set a value for an anlysis option.
@param @param code The code for the desired option.
@return @param v The desired value for the option specified.
@return Error code.
@see EN_Option
*/ */
int DLLEXPORT ENsetoption(int code, EN_API_FLOAT_TYPE v); int DLLEXPORT ENsetoption(int code, EN_API_FLOAT_TYPE v);

97
src/epanet.c
View File

@@ -1314,13 +1314,6 @@ int DLLEXPORT ENgetnodevalue(int index, int code, EN_API_FLOAT_TYPE *value)
int DLLEXPORT ENgetlinkindex(char *id, int *index) int DLLEXPORT ENgetlinkindex(char *id, int *index)
/*----------------------------------------------------------------
** Input: id = link ID
** Output: *index = index of link in list of links
** Returns: error code
** Purpose: retrieves index of a link with specific ID
**----------------------------------------------------------------
*/
{ {
*index = 0; *index = 0;
if (!Openflag) return(102); if (!Openflag) return(102);
@@ -1331,15 +1324,6 @@ int DLLEXPORT ENgetlinkindex(char *id, int *index)
int DLLEXPORT ENgetlinkid(int index, char *id) int DLLEXPORT ENgetlinkid(int index, char *id)
/*----------------------------------------------------------------
** Input: index = index of link in list of links
** Output: id = link ID
** Returns: error code
** Purpose: retrieves ID of a link with specific index
**
** NOTE: 'id' must be able to hold MAXID characters
**----------------------------------------------------------------
*/
{ {
strcpy(id,""); strcpy(id,"");
if (!Openflag) return(102); if (!Openflag) return(102);
@@ -1350,13 +1334,6 @@ int DLLEXPORT ENgetlinkid(int index, char *id)
int DLLEXPORT ENgetlinktype(int index, int *code) int DLLEXPORT ENgetlinktype(int index, int *code)
/*------------------------------------------------------------------
** Input: index = link index
** Output: *code = link type code number (see EPANET2.H)
** Returns: error code
** Purpose: retrieves link type of specific link
**------------------------------------------------------------------
*/
{ {
*code = -1; *code = -1;
if (!Openflag) return(102); if (!Openflag) return(102);
@@ -1367,14 +1344,6 @@ int DLLEXPORT ENgetlinktype(int index, int *code)
int DLLEXPORT ENgetlinknodes(int index, int *node1, int *node2) int DLLEXPORT ENgetlinknodes(int index, int *node1, int *node2)
/*----------------------------------------------------------------
** Input: index = link index
** Output: *node1 = index of link's starting node
** *node2 = index of link's ending node
** Returns: error code
** Purpose: retrieves end nodes of a specific link
**----------------------------------------------------------------
*/
{ {
*node1 = 0; *node1 = 0;
*node2 = 0; *node2 = 0;
@@ -1387,14 +1356,6 @@ int DLLEXPORT ENgetlinknodes(int index, int *node1, int *node2)
int DLLEXPORT ENgetlinkvalue(int index, int code, EN_API_FLOAT_TYPE *value) int DLLEXPORT ENgetlinkvalue(int index, int code, EN_API_FLOAT_TYPE *value)
/*------------------------------------------------------------------
** Input: index = link index
** code = link parameter code (see EPANET2.H)
** Output: *value = value of link's parameter
** Returns: error code
** Purpose: retrieves parameter value for a link
**------------------------------------------------------------------
*/
{ {
double a,h,q, v = 0.0; double a,h,q, v = 0.0;
@@ -1591,21 +1552,6 @@ int DLLEXPORT ENgetcurve(int curveIndex, char* id, int *nValues, EN_API_FLOAT_T
int DLLEXPORT ENsetcontrol(int cindex, int ctype, int lindex, int DLLEXPORT ENsetcontrol(int cindex, int ctype, int lindex,
EN_API_FLOAT_TYPE setting, int nindex, EN_API_FLOAT_TYPE level) EN_API_FLOAT_TYPE setting, int nindex, EN_API_FLOAT_TYPE level)
/*----------------------------------------------------------------
** Input: cindex = control index (position of control statement
** in the input file, starting from 1)
** ctype = control type code (see EPANET2.H)
** lindex = index of controlled link
** setting = control setting applied to link
** nindex = index of controlling node (0 for TIMER
** or TIMEOFDAY control)
** level = control level (tank level, junction pressure,
** or time (seconds))
** Output: none
** Returns: error code
** Purpose: specifies parameters that define a simple control
**----------------------------------------------------------------
*/
{ {
char status = ACTIVE; char status = ACTIVE;
long t = 0; long t = 0;
@@ -2011,14 +1957,6 @@ int DLLEXPORT ENsetlinkvalue(int index, int code, EN_API_FLOAT_TYPE v)
int DLLEXPORT ENaddpattern(char *id) int DLLEXPORT ENaddpattern(char *id)
/*----------------------------------------------------------------
** Input: id = ID name of the new pattern
** Output: none
** Returns: error code
** Purpose: adds a new time pattern appended to the end of the
** existing patterns.
**----------------------------------------------------------------
*/
{ {
int i, j, n, err = 0; int i, j, n, err = 0;
Spattern *tmpPat; Spattern *tmpPat;
@@ -2079,15 +2017,6 @@ int DLLEXPORT ENaddpattern(char *id)
int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *f, int n) int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *f, int n)
/*----------------------------------------------------------------
** Input: index = time pattern index
** *f = array of pattern multipliers
** n = number of time periods in pattern
** Output: none
** Returns: error code
** Purpose: sets multipliers for a specific time pattern
**----------------------------------------------------------------
*/
{ {
int j; int j;
@@ -2108,15 +2037,6 @@ int DLLEXPORT ENsetpattern(int index, EN_API_FLOAT_TYPE *f, int n)
int DLLEXPORT ENsetpatternvalue(int index, int period, EN_API_FLOAT_TYPE value) int DLLEXPORT ENsetpatternvalue(int index, int period, EN_API_FLOAT_TYPE value)
/*----------------------------------------------------------------
** Input: index = time pattern index
** period = time pattern period
** value = pattern multiplier
** Output: none
** Returns: error code
** Purpose: sets multiplier for a specific time period and pattern
**----------------------------------------------------------------
*/
{ {
if (!Openflag) return(102); if (!Openflag) return(102);
if (index <= 0 || index > Npats) return(205); if (index <= 0 || index > Npats) return(205);
@@ -2271,14 +2191,7 @@ int DLLEXPORT ENsetcurvevalue(int index, int pnt, EN_API_FLOAT_TYPE x, EN_API_
int DLLEXPORT ENsettimeparam(int code, long value) int DLLEXPORT ENsettimeparam(int code, long value)
/*----------------------------------------------------------------
** Input: code = time parameter code (see EPANET2.H)
** value = time parameter value
** Output: none
** Returns: error code
** Purpose: sets value for time parameter
**----------------------------------------------------------------
*/
{ {
if (!Openflag) return(102); if (!Openflag) return(102);
if (OpenHflag || OpenQflag) { if (OpenHflag || OpenQflag) {
@@ -2503,14 +2416,6 @@ int DLLEXPORT ENgetheadcurve(int index, char *id)
} }
int DLLEXPORT ENgetpumptype(int index, int *type) int DLLEXPORT ENgetpumptype(int index, int *type)
/*----------------------------------------------------------------
** Input: index = index of pump in list of links
** Output: type = PumpType
** Returns: error code
** Purpose: retrieves type of a pump for specific link index
**
**----------------------------------------------------------------
*/
{ {
*type=-1; *type=-1;
if (!Openflag) return(102); if (!Openflag) return(102);