define module groups externally

This commit is contained in:
Sam Hatchett
2015-09-30 15:14:54 -04:00
parent 41c47bcc09
commit 1c8b592e34
7 changed files with 122 additions and 0 deletions

0
doc/modules.dox Normal file
View File

View File

@@ -0,0 +1,19 @@
/**
@defgroup FileManagement File Management
@addtogroup FileManagement
@{
@fn int ENwriteline (char *line)
@fn int ENreport ()
@fn int ENresetreport ()
@fn int ENsetreport (char *reportFormat)
@fn int ENopen (char *inpFile, char *rptFile, char *binOutFile)
@fn int ENsaveinpfile (char *filename)
@}
*/

View File

@@ -0,0 +1,42 @@
/**
@defgroup HydraulicFunctions Hydraulic Analysis
~~~~~~~~~~~~~~~{.c}
int errcode;
long t, tstep;
errcode = ENopenH();
if (!errcode)
{
errcode = ENinitH(EN_SAVE);
if (!errcode) do
{
tstep = 0;
ERRCODE(ENrunH(&t));
ERRCODE(ENnextH(&tstep));
}
while (tstep > 0);
}
ENcloseH();
~~~~~~~~~~~~~~~
@addtogroup HydraulicFunctions
@{
@fn int ENsolveH()
@fn int ENsaveH()
@fn int ENopenH()
@fn int ENinitH(int initFlag)
@fn int ENrunH(long *currentTime)
@fn int ENnextH(long *tStep)
@fn int ENcloseH()
@fn int ENsavehydfile(char *filename)
@fn int ENusehydfile(char *filename)
@fn int ENgetstatistic(int code, EN_API_FLOAT_TYPE* value)
@}
*/

View File

@@ -0,0 +1,16 @@
/**
@defgroup NetworkInfo Network Info
@addtogroup NetworkInfo
@{
@fn int ENgetcount (int code, int *count)
@fn int ENgetnodeindex (char *id, int *index)
@fn int ENgetnodeid (int index, char *id)
@fn int ENgetnodetype (int index, int *code)
@fn int ENgetnodevalue (int index, int code, EN_API_FLOAT_TYPE *value)
@fn int ENgetcoord (int index, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y)
@fn int ENsetcoord (int index, EN_API_FLOAT_TYPE x, EN_API_FLOAT_TYPE y)
@}
*/

14
doc/modules_patterns.dox Normal file
View File

@@ -0,0 +1,14 @@
/**
@defgroup Patterns
@addtogroup Patterns
@{
@fn int ENgetpatternindex (char *id, int *index)
@fn int ENgetpatternid (int index, char *id)
@fn int ENgetpatternlen (int index, int *len)
@fn int ENgetpatternvalue (int index, int period, EN_API_FLOAT_TYPE *value)
@fn int ENgetaveragepatternvalue (int index, EN_API_FLOAT_TYPE *value)
@}
*/

View File

@@ -0,0 +1,17 @@
/**
@defgroup QualityFunctions Water Quality Functions
@addtogroup QualityFunctions
@{
@fn int ENsolveQ ()
@fn int ENopenQ ()
@fn int ENinitQ (int saveFlag)
@fn int ENrunQ (long *currentTime)
@fn int ENnextQ (long *tStep)
@fn int ENstepQ (long *timeLeft)
@fn int ENcloseQ ()
@}
*/

View File

@@ -0,0 +1,14 @@
/**
@defgroup ToolkitOptions Toolkit Options
@addtogroup ToolkitOptions
@{
@fn int ENgetoption (int code, EN_API_FLOAT_TYPE *value)
@fn int ENgettimeparam (int code, long *value)
@fn int ENgetflowunits (int *code)
@fn int ENgetqualtype (int *qualcode, int *tracenode)
@fn int ENgeterror (int errcode, char *errmsg, int maxLen)
@}
*/