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

Updates documentation with newly added functions

Browse Source
This commit is contained in:
Lew Rossman
2019-02-08 19:06:42 -05:00
parent 2c86a8febb
commit 996e26158c
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
ReleaseNotes2_2.md
View File

@@ -178,6 +178,9 @@ Both network files are available [here](https://doi.org/10.23719/1375314).
|`EN_getelseaction`|Gets the contents of an ELSE action in a rule-based control| |`EN_getelseaction`|Gets the contents of an ELSE action in a rule-based control|
|`EN_setelseaction`|Set the contents of an ELSE action in a rule-based control| |`EN_setelseaction`|Set the contents of an ELSE action in a rule-based control|
|`EN_setrulepriority`|Sets the priority of a rule-based control| |`EN_setrulepriority`|Sets the priority of a rule-based control|
|`EN_gettitle` |Gets a project's title |
|`EN_settitle` |Sets a project's title |
|`EN_clearreport` |Clears the contents of a project's report file |
In addition to these new functions, a tank's volume curve `EN_VOLCURVE` can be set using `EN_setnodevalue` and `EN_setlinkvalue` can now be used to set the following pump properties: In addition to these new functions, a tank's volume curve `EN_VOLCURVE` can be set using `EN_setnodevalue` and `EN_setlinkvalue` can now be used to set the following pump properties:
- `EN_PUMP_POWER` (constant power rating) - `EN_PUMP_POWER` (constant power rating)
- `EN_PUMP_HCURVE` (head characteristic curve) - `EN_PUMP_HCURVE` (head characteristic curve)

5
doc/modules.dox
View File

@@ -71,6 +71,9 @@ These are symbolic constants used as function arguments.
@fn int EN_runproject(EN_Project ph, const char *f1, const char *f2, const char *f3, void (*pviewprog)(char *)) @fn int EN_runproject(EN_Project ph, const char *f1, const char *f2, const char *f3, void (*pviewprog)(char *))
@fn int EN_init(EN_Project ph, const char *rptFile, const char *outFile, int unitsType, int headLossType) @fn int EN_init(EN_Project ph, const char *rptFile, const char *outFile, int unitsType, int headLossType)
@fn int EN_open(EN_Project ph, const char *inpFile, const char *rptFile, const char *binOutFile) @fn int EN_open(EN_Project ph, const char *inpFile, const char *rptFile, const char *binOutFile)
@fn int EN_getcount(EN_Project ph, int code, int *count)
@fn int EN_gettitle(EN_Project ph, char *line1, char *line2, char *line3)
@fn int EN_settitle(EN_Project ph, char *line1, char *line2, char *line3)
@fn int EN_saveinpfile(EN_Project ph, const char *filename) @fn int EN_saveinpfile(EN_Project ph, const char *filename)
@fn int EN_close(EN_Project ph) @fn int EN_close(EN_Project ph)
@} @}
@@ -109,11 +112,11 @@ These are symbolic constants used as function arguments.
@{ @{
@fn int EN_writeline(EN_Project ph, char *line) @fn int EN_writeline(EN_Project ph, char *line)
@fn int EN_report(EN_Project ph) @fn int EN_report(EN_Project ph)
@fn int EN_clearreport(EN_Project ph)
@fn int EN_resetreport(EN_Project ph) @fn int EN_resetreport(EN_Project ph)
@fn int EN_setreport(EN_Project ph, char *reportFormat) @fn int EN_setreport(EN_Project ph, char *reportFormat)
@fn int EN_setstatusreport(EN_Project ph, int code) @fn int EN_setstatusreport(EN_Project ph, int code)
@fn int EN_getversion(int *version) @fn int EN_getversion(int *version)
@fn int EN_getcount(EN_Project ph, int code, int *count)
@fn int EN_geterror(int errcode, char *errmsg, int maxLen) @fn int EN_geterror(int errcode, char *errmsg, int maxLen)
@fn int EN_getstatistic(EN_Project ph, int type, double* value) @fn int EN_getstatistic(EN_Project ph, int type, double* value)
@} @}