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

PDA fixes

Browse Source
This commit is contained in:
Lew Rossman
2019-07-22 09:50:41 -04:00
parent 3fe11b98ee
commit a89f339525
18 changed files with 814 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
include/epanet2_2.h
View File

@@ -11,7 +11,7 @@
Authors: see AUTHORS
Copyright: see AUTHORS
License: see LICENSE
Last Updated: 05/30/2019
Last Updated: 07/20/2019
******************************************************************************
*/
@@ -94,7 +94,7 @@ typedef struct Project *EN_Project;
the pviewprog argument should be `NULL`.
*/
int DLLEXPORT EN_runproject(EN_Project ph, const char *inpFile, const char *rptFile,
const char *outputFile, void (*pviewprog)(char *));
const char *outFile, void (*pviewprog)(char *));
/**
@brief Initializes an EPANET project.
@@ -129,9 +129,9 @@ typedef struct Project *EN_Project;
/**
@brief Retrieves the title lines of the project
@param ph an EPANET project handle.
@param[out] line1 first title line
@param[out] line2 second title line
@param[out] line3 third title line
@param[out] out_line1 first title line
@param[out] out_line2 second title line
@param[out] out_line3 third title line
@return an error code
*/
int DLLEXPORT EN_gettitle(EN_Project ph, char *out_line1, char *out_line2, char *out_line3);
@@ -151,7 +151,7 @@ typedef struct Project *EN_Project;
@param ph an EPANET project handle.
@param object a type of object (either EN_NODE, EN_LINK, EN_TIMEPAT or EN_CURVE)
@param index the object's index starting from 1
@param[out] comment the comment string assigned to the object
@param[out] out_comment the comment string assigned to the object
@return an error code
*/
int DLLEXPORT EN_getcomment(EN_Project ph, int object, int index, char *out_comment);
@@ -223,7 +223,7 @@ typedef struct Project *EN_Project;
EN_solveH(ph);
EN_solveQ(ph);
EN_report(ph);
EN_deleteproject(&ph);
EN_deleteproject(ph);
\endcode
*/
int DLLEXPORT EN_solveH(EN_Project ph);
@@ -621,7 +621,7 @@ typedef struct Project *EN_Project;
/**
@brief Returns the text of an error message generated by an error code.
@param errcode an error code.
@param[out] errmsg the error message generated by the error code
@param[out] out_errmsg the error message generated by the error code
@param maxLen maximum number of characters that errmsg can hold
@return an error code
@@ -707,8 +707,8 @@ typedef struct Project *EN_Project;
@brief Gets information about the type of water quality analysis requested.
@param ph an EPANET project handle.
@param[out] qualType type of analysis to run (see @ref EN_QualityType).
@param[out] chemName name of chemical constituent.
@param[out] chemUnits concentration units of the constituent.
@param[out] out_chemName name of chemical constituent.
@param[out] out_chemUnits concentration units of the constituent.
@param[out] traceNode index of the node being traced (if applicable).
@return an error code.
*/
@@ -787,7 +787,7 @@ typedef struct Project *EN_Project;
@brief Gets the ID name of a node given its index.
@param ph an EPANET project handle.
@param index a node's index (starting from 1).
@param[out] id the node's ID name.
@param[out] out_id the node's ID name.
@return an error code
The ID name must be sized to hold at least @ref EN_SizeLimits "EN_MAXID" characters.
@@ -1032,7 +1032,7 @@ typedef struct Project *EN_Project;
@param ph an EPANET project handle.
@param nodeIndex a node's index (starting from 1).
@param demandIndex the index of one of the node's demand categories (starting from 1).
@param[out] demandName The name of the selected category.
@param[out] out_demandName The name of the selected category.
@return an error code.
\b demandName must be sized to contain at least @ref EN_SizeLimits "EN_MAXID" characters.
@@ -1111,7 +1111,7 @@ typedef struct Project *EN_Project;
@brief Gets the ID name of a link given its index.
@param ph an EPANET project handle.
@param index a link's index (starting from 1).
@param[out] id The link's ID name.
@param[out] out_id The link's ID name.
@return an error code.
The ID name must be sized to hold at least @ref EN_SizeLimits "EN_MAXID" characters.
@@ -1141,7 +1141,7 @@ typedef struct Project *EN_Project;
/**
@brief Changes a link's type.
@param ph an EPANET project handle.
@param[in,out] index the link's index before [in] and after [out] the type change.
@param[in,out] inout_index the link's index before [in] and after [out] the type change.
@param linkType the new type to change the link to (see @ref EN_LinkType).
@param actionCode the action taken if any controls contain the link.
@return an error code.
@@ -1283,7 +1283,7 @@ typedef struct Project *EN_Project;
@brief Retrieves the ID name of a time pattern given its index.
@param ph an EPANET project handle.
@param index a time pattern index (starting from 1).
@param[out] id the time pattern's ID name.
@param[out] out_id the time pattern's ID name.
@return an error code.
The ID name must be sized to hold at least @ref EN_SizeLimits "EN_MAXID" characters.
@@ -1391,7 +1391,7 @@ typedef struct Project *EN_Project;
@brief Retrieves the ID name of a curve given its index.
@param ph an EPANET project handle.
@param index a curve's index (starting from 1).
@param[out] id the curve's ID name.
@param[out] out_id the curve's ID name.
@return an error code.
The ID name must be sized to hold at least @ref EN_SizeLimits "EN_MAXID" characters.
@@ -1455,7 +1455,7 @@ typedef struct Project *EN_Project;
@brief Retrieves all of a curve's data.
@param ph an EPANET project handle.
@param index a curve's index (starting from 1).
@param[out] id the curve's ID name.
@param[out] out_id the curve's ID name.
@param[out] nPoints the number of data points on the curve.
@param[out] xValues the curve's x-values.
@param[out] yValues the curve's y-values.
@@ -1590,7 +1590,7 @@ typedef struct Project *EN_Project;
@brief Gets the ID name of a rule-based control given its index.
@param ph an EPANET project handle.
@param index the rule's index (starting from 1).
@param[out] id the rule's ID name.
@param[out] out_id the rule's ID name.
@return Error code.
The ID name must be sized to hold at least @ref EN_SizeLimits "EN_MAXID" characters.