Merge branch 'dev-2.1-doxy-markup' into dev-2.1
updates comment blocks to oxygen-compatible, and adds release notes (draft)
This commit is contained in:
Sam Hatchett
@@ -1,3 +1,8 @@
|
||||
/** @file epanet2.h
|
||||
@see http://github.com/openwateranalytics/epanet
|
||||
|
||||
*/
|
||||
|
||||
/*
|
||||
*******************************************************************
|
||||
|
||||
@@ -15,6 +20,7 @@
|
||||
*******************************************************************
|
||||
*/
|
||||
|
||||
|
||||
#ifndef EPANET2_H
|
||||
#define EPANET2_H
|
||||
|
||||
@@ -57,231 +63,844 @@
|
||||
|
||||
// --- Define the EPANET toolkit constants
|
||||
|
||||
#define EN_ELEVATION 0 /* Node parameters */
|
||||
#define EN_BASEDEMAND 1
|
||||
#define EN_PATTERN 2
|
||||
#define EN_EMITTER 3
|
||||
#define EN_INITQUAL 4
|
||||
#define EN_SOURCEQUAL 5
|
||||
#define EN_SOURCEPAT 6
|
||||
#define EN_SOURCETYPE 7
|
||||
#define EN_TANKLEVEL 8
|
||||
#define EN_DEMAND 9
|
||||
#define EN_HEAD 10
|
||||
#define EN_PRESSURE 11
|
||||
#define EN_QUALITY 12
|
||||
#define EN_SOURCEMASS 13
|
||||
#define EN_INITVOLUME 14
|
||||
#define EN_MIXMODEL 15
|
||||
#define EN_MIXZONEVOL 16
|
||||
/// Node property codes
|
||||
typedef enum {
|
||||
EN_ELEVATION = 0, /**< Node Elevation */
|
||||
EN_BASEDEMAND = 1, /**< Node Base Demand, from last demand category */
|
||||
EN_PATTERN = 2, /**< Node Demand Pattern */
|
||||
EN_EMITTER = 3, /**< Node Emitter Coefficient */
|
||||
EN_INITQUAL = 4, /**< Node initial quality */
|
||||
EN_SOURCEQUAL = 5, /**< Node source quality */
|
||||
EN_SOURCEPAT = 6, /**< Node source pattern index */
|
||||
EN_SOURCETYPE = 7, /**< Node source type */
|
||||
EN_TANKLEVEL = 8, /**< Tank Level */
|
||||
EN_DEMAND = 9, /**< Node current simulated demand */
|
||||
EN_HEAD = 10, /**< Node Head value */
|
||||
EN_PRESSURE = 11, /**< Node pressure value */
|
||||
EN_QUALITY = 12, /**< Node quality value */
|
||||
EN_SOURCEMASS = 13, /**< Node source mass value */
|
||||
EN_INITVOLUME = 14, /**< Tank or Reservoir initial volume */
|
||||
EN_MIXMODEL = 15, /**< Tank mixing model */
|
||||
EN_MIXZONEVOL = 16, /**< Tank mixing zone volume */
|
||||
EN_TANKDIAM = 17, /**< Tank diameter */
|
||||
EN_MINVOLUME = 18, /**< Tank minimum volume */
|
||||
EN_VOLCURVE = 19, /**< Tank volume curve index */
|
||||
EN_MINLEVEL = 20, /**< Tank minimum level */
|
||||
EN_MAXLEVEL = 21, /**< Tank maximum level */
|
||||
EN_MIXFRACTION = 22, /**< Tank mixing fraction */
|
||||
EN_TANK_KBULK = 23, /**< Tank bulk decay coefficient */
|
||||
EN_TANKVOLUME = 24, /**< Tank current volume */
|
||||
EN_MAXVOLUME = 25 /**< Tank maximum volume */
|
||||
} EN_NodeProperty;
|
||||
|
||||
#define EN_TANKDIAM 17
|
||||
#define EN_MINVOLUME 18
|
||||
#define EN_VOLCURVE 19
|
||||
#define EN_MINLEVEL 20
|
||||
#define EN_MAXLEVEL 21
|
||||
#define EN_MIXFRACTION 22
|
||||
#define EN_TANK_KBULK 23
|
||||
#define EN_TANKVOLUME 24
|
||||
#define EN_MAXVOLUME 25
|
||||
/// Link property codes
|
||||
typedef enum {
|
||||
EN_DIAMETER = 0,
|
||||
EN_LENGTH = 1,
|
||||
EN_ROUGHNESS = 2,
|
||||
EN_MINORLOSS = 3,
|
||||
EN_INITSTATUS = 4,
|
||||
EN_INITSETTING = 5,
|
||||
EN_KBULK = 6,
|
||||
EN_KWALL = 7,
|
||||
EN_FLOW = 8,
|
||||
EN_VELOCITY = 9,
|
||||
EN_HEADLOSS = 10,
|
||||
EN_STATUS = 11,
|
||||
EN_SETTING = 12,
|
||||
EN_ENERGY = 13,
|
||||
EN_LINKQUAL = 14,
|
||||
EN_LINKPATTERN = 15
|
||||
} EN_LinkProperty;
|
||||
|
||||
#define EN_DIAMETER 0 /* Link parameters */
|
||||
#define EN_LENGTH 1
|
||||
#define EN_ROUGHNESS 2
|
||||
#define EN_MINORLOSS 3
|
||||
#define EN_INITSTATUS 4
|
||||
#define EN_INITSETTING 5
|
||||
#define EN_KBULK 6
|
||||
#define EN_KWALL 7
|
||||
#define EN_FLOW 8
|
||||
#define EN_VELOCITY 9
|
||||
#define EN_HEADLOSS 10
|
||||
#define EN_STATUS 11
|
||||
#define EN_SETTING 12
|
||||
#define EN_ENERGY 13
|
||||
#define EN_LINKQUAL 14
|
||||
#define EN_LINKPATTERN 15
|
||||
/// 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_RELATIVEERROR 1
|
||||
typedef enum {
|
||||
EN_ITERATIONS = 0,
|
||||
EN_RELATIVEERROR = 1
|
||||
} EN_AnalysisStatistic;
|
||||
|
||||
#define EN_NODECOUNT 0 /* Component counts */
|
||||
#define EN_TANKCOUNT 1
|
||||
#define EN_LINKCOUNT 2
|
||||
#define EN_PATCOUNT 3
|
||||
#define EN_CURVECOUNT 4
|
||||
#define EN_CONTROLCOUNT 5
|
||||
typedef enum {
|
||||
EN_NODECOUNT = 0, /**< Number of Nodes (Juntions + Tanks + Reservoirs) */
|
||||
EN_TANKCOUNT = 1, /**< Number of Tanks */
|
||||
EN_LINKCOUNT = 2, /**< Number of Links (Pipes + Pumps + Valves) */
|
||||
EN_PATCOUNT = 3, /**< Number of Time Patterns */
|
||||
EN_CURVECOUNT = 4, /**< Number of Curves */
|
||||
EN_CONTROLCOUNT = 5 /**< Number of Control Statements */
|
||||
} EN_CountType;
|
||||
|
||||
#define EN_JUNCTION 0 /* Node types */
|
||||
#define EN_RESERVOIR 1
|
||||
#define EN_TANK 2
|
||||
typedef enum {
|
||||
EN_JUNCTION = 0,
|
||||
EN_RESERVOIR = 1,
|
||||
EN_TANK = 2
|
||||
} EN_NodeType;
|
||||
|
||||
#define EN_CVPIPE 0 /* Link types. */
|
||||
#define EN_PIPE 1 /* See LinkType in TYPES.H */
|
||||
#define EN_PUMP 2
|
||||
#define EN_PRV 3
|
||||
#define EN_PSV 4
|
||||
#define EN_PBV 5
|
||||
#define EN_FCV 6
|
||||
#define EN_TCV 7
|
||||
#define EN_GPV 8
|
||||
|
||||
#define EN_NONE 0 /* Quality analysis types. */
|
||||
#define EN_CHEM 1 /* See QualType in TYPES.H */
|
||||
#define EN_AGE 2
|
||||
#define EN_TRACE 3
|
||||
typedef enum {
|
||||
EN_CVPIPE = 0, /* Link types. */
|
||||
EN_PIPE = 1, /* See LinkType in TYPES.H */
|
||||
EN_PUMP = 2,
|
||||
EN_PRV = 3,
|
||||
EN_PSV = 4,
|
||||
EN_PBV = 5,
|
||||
EN_FCV = 6,
|
||||
EN_TCV = 7,
|
||||
EN_GPV = 8
|
||||
} EN_LinkType;
|
||||
|
||||
#define EN_CONCEN 0 /* Source quality types. */
|
||||
#define EN_MASS 1 /* See SourceType in TYPES.H. */
|
||||
#define EN_SETPOINT 2
|
||||
#define EN_FLOWPACED 3
|
||||
|
||||
#define EN_CFS 0 /* Flow units types. */
|
||||
#define EN_GPM 1 /* See FlowUnitsType */
|
||||
#define EN_MGD 2 /* in TYPES.H. */
|
||||
#define EN_IMGD 3
|
||||
#define EN_AFD 4
|
||||
#define EN_LPS 5
|
||||
#define EN_LPM 6
|
||||
#define EN_MLD 7
|
||||
#define EN_CMH 8
|
||||
#define EN_CMD 9
|
||||
typedef enum {
|
||||
EN_NONE = 0, /* Quality analysis types. */
|
||||
EN_CHEM = 1, /* See QualType in TYPES.H */
|
||||
EN_AGE = 2,
|
||||
EN_TRACE = 3
|
||||
} EN_QualityType;
|
||||
|
||||
#define EN_TRIALS 0 /* Misc. options */
|
||||
#define EN_ACCURACY 1
|
||||
#define EN_TOLERANCE 2
|
||||
#define EN_EMITEXPON 3
|
||||
#define EN_DEMANDMULT 4
|
||||
typedef enum {
|
||||
EN_CONCEN = 0, /* Source quality types. */
|
||||
EN_MASS = 1, /* See SourceType in TYPES.H. */
|
||||
EN_SETPOINT = 2,
|
||||
EN_FLOWPACED = 3
|
||||
} EN_SourceType;
|
||||
|
||||
#define EN_LOWLEVEL 0 /* Control types. */
|
||||
#define EN_HILEVEL 1 /* See ControlType */
|
||||
#define EN_TIMER 2 /* in TYPES.H. */
|
||||
#define EN_TIMEOFDAY 3
|
||||
typedef enum {
|
||||
EN_CFS = 0, /* Flow units types. */
|
||||
EN_GPM = 1, /* See FlowUnitsType */
|
||||
EN_MGD = 2, /* in TYPES.H. */
|
||||
EN_IMGD = 3,
|
||||
EN_AFD = 4,
|
||||
EN_LPS = 5,
|
||||
EN_LPM = 6,
|
||||
EN_MLD = 7,
|
||||
EN_CMH = 8,
|
||||
EN_CMD = 9
|
||||
} EN_FlowUnits;
|
||||
|
||||
#define EN_AVERAGE 1 /* Time statistic types. */
|
||||
#define EN_MINIMUM 2 /* See TstatType in TYPES.H */
|
||||
#define EN_MAXIMUM 3
|
||||
#define EN_RANGE 4
|
||||
|
||||
#define EN_MIX1 0 /* Tank mixing models */
|
||||
#define EN_MIX2 1
|
||||
#define EN_FIFO 2
|
||||
#define EN_LIFO 3
|
||||
/// Simulation Option codes
|
||||
typedef enum {
|
||||
EN_TRIALS = 0,
|
||||
EN_ACCURACY = 1,
|
||||
EN_TOLERANCE = 2,
|
||||
EN_EMITEXPON = 3,
|
||||
EN_DEMANDMULT = 4
|
||||
} EN_Option;
|
||||
|
||||
#define EN_NOSAVE 0 /* Save-results-to-file flag */
|
||||
#define EN_SAVE 1
|
||||
typedef enum {
|
||||
EN_LOWLEVEL = 0, /* Control types. */
|
||||
EN_HILEVEL = 1, /* See ControlType */
|
||||
EN_TIMER = 2, /* in TYPES.H. */
|
||||
EN_TIMEOFDAY = 3
|
||||
} EN_ControlType;
|
||||
|
||||
|
||||
|
||||
typedef enum {
|
||||
EN_AVERAGE = 1, /* Time statistic types. */
|
||||
EN_MINIMUM = 2, /* See TstatType in TYPES.H */
|
||||
EN_MAXIMUM = 3,
|
||||
EN_RANGE = 4
|
||||
} EN_StatisticType;
|
||||
|
||||
|
||||
|
||||
typedef enum {
|
||||
EN_MIX1 = 0, /* Tank mixing models */
|
||||
EN_MIX2 = 1,
|
||||
EN_FIFO = 2,
|
||||
EN_LIFO = 3
|
||||
} EN_MixingModel;
|
||||
|
||||
|
||||
|
||||
typedef enum {
|
||||
EN_NOSAVE = 0,
|
||||
EN_SAVE = 1,
|
||||
EN_INITFLOW = 10,
|
||||
EN_SAVE_AND_INIT = 11
|
||||
} EN_SaveOption;
|
||||
|
||||
|
||||
|
||||
typedef enum {
|
||||
EN_CONST_HP = 0, /* constant horsepower */
|
||||
EN_POWER_FUNC = 1, /* power function */
|
||||
EN_CUSTOM = 2 /* user-defined custom curve */
|
||||
} EN_CurveType;
|
||||
|
||||
#define EN_INITFLOW 10 /* Re-initialize flows flag */
|
||||
|
||||
#define EN_CONST_HP 0 /* constant horsepower */
|
||||
#define EN_POWER_FUNC 1 /* power function */
|
||||
#define EN_CUSTOM 2 /* user-defined custom curve */
|
||||
|
||||
// --- Declare the EPANET toolkit functions
|
||||
#if defined(__cplusplus)
|
||||
extern "C" {
|
||||
#endif
|
||||
/**
|
||||
@brief runs a complete EPANET simulation
|
||||
@param inpFile pointer to name of input file (must exist)
|
||||
@param rptFile pointer to name of report file (to be created)
|
||||
@param binOutFile pointer to name of binary output file (to be created)
|
||||
@param callback a callback function that takes a character string (char *) as its only parameter.
|
||||
@return error code
|
||||
|
||||
The callback function should reside in and be used by the calling
|
||||
code to display the progress messages that EPANET generates
|
||||
as it carries out its computations. If this feature is not
|
||||
needed then the argument should be NULL.
|
||||
*/
|
||||
int DLLEXPORT ENepanet(char *inpFile, char *rptFile, char *binOutFile, void (*callback) (char *));
|
||||
|
||||
/**
|
||||
@brief Opens EPANET input file & reads in network data
|
||||
@param inpFile pointer to name of input file (must exist)
|
||||
@param rptFile pointer to name of report file (to be created)
|
||||
@param binOutFile pointer to name of binary output file (to be created)
|
||||
@return error code
|
||||
*/
|
||||
int DLLEXPORT ENopen(char *inpFile, char *rptFile, char *binOutFile);
|
||||
|
||||
/**
|
||||
@brief Saves current data to "INP" formatted text file.
|
||||
@param filename The file path to create
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENsaveinpfile(char *filename);
|
||||
|
||||
/**
|
||||
@brief Frees all memory and files used by EPANET
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENclose();
|
||||
|
||||
/**
|
||||
@brief Solves the network hydraulics for all time periods
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENsolveH();
|
||||
|
||||
/**
|
||||
@brief Saves hydraulic results to binary file
|
||||
@return Error code
|
||||
|
||||
Must be called before ENreport() if no WQ simulation has been made.
|
||||
Should not be called if ENsolveQ() will be used.
|
||||
*/
|
||||
int DLLEXPORT ENsaveH();
|
||||
|
||||
/**
|
||||
@brief Sets up data structures for hydraulic analysis
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENopenH();
|
||||
|
||||
/**
|
||||
@brief Initializes hydraulic analysis
|
||||
@param initFlag 2-digit flag where 1st (left) digit indicates if link flows should be re-initialized (1) or not (0), and 2nd digit indicates if hydraulic results should be saved to file (1) or not (0).
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENinitH(int initFlag);
|
||||
|
||||
/**
|
||||
@brief Run a hydraulic solution period
|
||||
@param[out] currentTime The current simulation time in seconds
|
||||
@return Error or warning code
|
||||
@see ENsolveH
|
||||
|
||||
This function is used in a loop with ENnextH() to run
|
||||
an extended period hydraulic simulation.
|
||||
See ENsolveH() for an example.
|
||||
*/
|
||||
int DLLEXPORT ENrunH(long *currentTime);
|
||||
|
||||
/**
|
||||
@brief Determine time (in seconds) until next hydraulic event
|
||||
@param[out] tStep Time (seconds) until next hydraulic event. 0 marks end of simulation period.
|
||||
@return Error code
|
||||
|
||||
This function is used in a loop with ENrunH() to run an extended period hydraulic simulation.
|
||||
See ENsolveH() for an example.
|
||||
*/
|
||||
int DLLEXPORT ENnextH(long *tStep);
|
||||
|
||||
|
||||
/**
|
||||
@brief Frees data allocated by hydraulics solver
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENcloseH();
|
||||
|
||||
/**
|
||||
@brief Copies binary hydraulics file to disk
|
||||
@param filename Name of file to be created
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENsavehydfile(char *filename);
|
||||
|
||||
/**
|
||||
@brief Opens previously saved binary hydraulics file
|
||||
@param filename Name of file to be used
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENusehydfile(char *filename);
|
||||
|
||||
/**
|
||||
@brief Solves for network water quality in all time periods
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENsolveQ();
|
||||
|
||||
/**
|
||||
@brief Sets up data structures for WQ analysis
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENopenQ();
|
||||
|
||||
/**
|
||||
@brief Initializes water quality analysis
|
||||
@param saveFlag EN_SAVE (1) if results saved to file, EN_NOSAVE (0) if not
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENinitQ(int saveFlag);
|
||||
|
||||
/**
|
||||
@brief Retrieves hydraulic & WQ results at time t.
|
||||
@param[out] currentTime Current simulation time, in seconds.
|
||||
@return Error code
|
||||
|
||||
This function is used in a loop with ENnextQ() to run
|
||||
an extended period WQ simulation. See ENsolveQ() for
|
||||
an example.
|
||||
*/
|
||||
int DLLEXPORT ENrunQ(long *currentTime);
|
||||
|
||||
/**
|
||||
@brief Advances WQ simulation to next hydraulic event.
|
||||
@param[out] tStep Time in seconds until next hydraulic event. 0 marks end of simulation period.
|
||||
@return Error code
|
||||
|
||||
This function is used in a loop with ENrunQ() to run
|
||||
an extended period WQ simulation. See ENsolveQ() for
|
||||
an example.
|
||||
*/
|
||||
int DLLEXPORT ENnextQ(long *tStep);
|
||||
|
||||
/**
|
||||
@brief Advances WQ simulation by a single WQ time step
|
||||
@param[out] timeLeft Time left in overall simulation (in seconds)
|
||||
@return Error code
|
||||
|
||||
This function is used in a loop with ENrunQ() to run
|
||||
an extended period WQ simulation.
|
||||
*/
|
||||
int DLLEXPORT ENstepQ(long *timeLeft);
|
||||
|
||||
/**
|
||||
@brief Frees data allocated by water quality solver.
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENcloseQ();
|
||||
|
||||
/**
|
||||
@brief Writes line of text to the report file.
|
||||
@param line Text string to write
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENwriteline(char *line);
|
||||
|
||||
/**
|
||||
@brief Writes simulation report to the report file
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENreport();
|
||||
|
||||
/**
|
||||
@brief Resets report options to default values
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENresetreport();
|
||||
|
||||
/**
|
||||
@brief Processes a reporting format command
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENsetreport(char *reportFormat);
|
||||
|
||||
int DLLEXPORT ENgetcontrol(int controlIndex, int *controlType, int *linkIdx, EN_API_FLOAT_TYPE *setting, int *nodeIdx, EN_API_FLOAT_TYPE *level);
|
||||
/**
|
||||
@brief Retrieves parameters that define a simple control
|
||||
@param controlIndex Control index (position of control statement in the input file, starting from 1)
|
||||
@param[out] controlType Control type code (see EPANET2.H)
|
||||
@param[out] linkIndex Index of controlled link
|
||||
@param[out] setting Control setting on link
|
||||
@param[out] nodeIndex Index of controlling node (0 for TIMER or TIMEOFDAY control)
|
||||
@param[out] level Control level (tank level, junction pressure, or time (seconds))
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetcontrol(int controlIndex, int *controlType, int *linkIndex, EN_API_FLOAT_TYPE *setting, int *nodeIndex, EN_API_FLOAT_TYPE *level);
|
||||
|
||||
/**
|
||||
@brief Retrieves the number of components of a given type in the network.
|
||||
@param code Component code (see EPANET2.H)
|
||||
@param[out] count Number of components in network
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetcount(int code, int *count);
|
||||
|
||||
/**
|
||||
@brief Gets value for an analysis option
|
||||
@param code Option code (see EPANET2.H)
|
||||
@param[out] value Option value
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetoption(int code, EN_API_FLOAT_TYPE *value);
|
||||
|
||||
/**
|
||||
@brief Retrieves value of specific time parameter.
|
||||
@param code Time parameter code
|
||||
@param[out] value Value of time parameter.
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgettimeparam(int code, long *value);
|
||||
|
||||
/**
|
||||
@brief Retrieves the flow units code
|
||||
@param[out] code Code of flow units in use
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetflowunits(int *code);
|
||||
|
||||
/**
|
||||
@brief Retrieves the index of the time pattern with specified ID
|
||||
@param id String ID of the time pattern
|
||||
@param[out] index Index of the specified time pattern
|
||||
@return Error code
|
||||
@see ENgetpatternid
|
||||
*/
|
||||
int DLLEXPORT ENgetpatternindex(char *id, int *index);
|
||||
|
||||
/**
|
||||
@brief Retrieves ID of a time pattern with specific index.
|
||||
@param index The index of a time pattern.
|
||||
@param[out] id The string ID of the time pattern.
|
||||
@return Error code
|
||||
@see ENgetpatternindex
|
||||
*/
|
||||
int DLLEXPORT ENgetpatternid(int index, char *id);
|
||||
|
||||
/**
|
||||
@brief Retrieves the number of multipliers in a time pattern.
|
||||
@param index The index of a time pattern.
|
||||
@param[out] len The length of the time pattern.
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetpatternlen(int index, int *len);
|
||||
|
||||
/**
|
||||
@brief Retrive a multiplier from a pattern for a specific time period.
|
||||
@param index The index of a time pattern
|
||||
@param period The pattern time period. First time period is 1.
|
||||
@param[out] value Pattern multiplier
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetpatternvalue(int index, int period, EN_API_FLOAT_TYPE *value);
|
||||
|
||||
/**
|
||||
@brief Retrieve the average multiplier value in a time pattern
|
||||
@param index The index of a time pattern
|
||||
@param[out] value The average of all of this time pattern's values
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetaveragepatternvalue(int index, EN_API_FLOAT_TYPE *value);
|
||||
|
||||
/**
|
||||
@brief Retrieve the type of quality analytis to be run.
|
||||
@param[out] qualcode The quality analysis code number.
|
||||
@param[out] tracenode The index of node being traced, if qualcode == trace
|
||||
@return Error code
|
||||
@see ENsetqualtype
|
||||
*/
|
||||
int DLLEXPORT ENgetqualtype(int *qualcode, int *tracenode);
|
||||
|
||||
/**
|
||||
@brief Get the text of an error code.
|
||||
@param errcode The error code
|
||||
@param[out] errmsg The error string represented by the code
|
||||
@param maxLen The maximum number of characters to copy into the char pointer errmsg
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgeterror(int errcode, char *errmsg, int maxLen);
|
||||
|
||||
/**
|
||||
@brief Get hydraulic simulation statistic
|
||||
@param code The type of statistic to get
|
||||
@param[out] value The value of the statistic
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetstatistic(int code, EN_API_FLOAT_TYPE* value);
|
||||
|
||||
/**
|
||||
@brief Get index of node with specified ID
|
||||
@param id The string ID of the node
|
||||
@param[out] index The node's index (first node is index 1)
|
||||
@return Error code
|
||||
@see ENgetnodeid
|
||||
*/
|
||||
int DLLEXPORT ENgetnodeindex(char *id, int *index);
|
||||
|
||||
/**
|
||||
@brief Get the string ID of the specified node.
|
||||
@param index The index of the node (first node is index 1)
|
||||
@param[out] id The string ID of the specified node. 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 ENgetnodeindex
|
||||
*/
|
||||
int DLLEXPORT ENgetnodeid(int index, char *id);
|
||||
|
||||
/**
|
||||
@brief Get the type of node with specified index.
|
||||
@param index The index of a node (first node is index 1)
|
||||
@param[out] code The type code for the node.
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetnodetype(int index, int *code);
|
||||
|
||||
/**
|
||||
@brief Get a property value for specified node
|
||||
@param index The index of a node (first node is index 1).
|
||||
@param code The property type code
|
||||
@param[out] value The value of the node's property.
|
||||
@return Error code
|
||||
@see EN_NodeProperty
|
||||
*/
|
||||
int DLLEXPORT ENgetnodevalue(int index, int code, EN_API_FLOAT_TYPE *value);
|
||||
|
||||
/**
|
||||
@brief Get coordinates (x,y) for a node.
|
||||
@param index The index of a node (first node is index 1).
|
||||
@param[out] x X-value of node's coordinate
|
||||
@param[out] y Y-value of node's coordinate
|
||||
@return Error code
|
||||
@see ENsetcoord
|
||||
*/
|
||||
int DLLEXPORT ENgetcoord(int index, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y);
|
||||
|
||||
/**
|
||||
@brief Set coordinates (x,y) for a node.
|
||||
@param index The index of a node (first node is index 1)
|
||||
@param x X-value of node's coordinate
|
||||
@param y Y-value of node's coordinate
|
||||
@return Error code
|
||||
@see ENgetcoord
|
||||
*/
|
||||
int DLLEXPORT ENsetcoord(int index, EN_API_FLOAT_TYPE x, EN_API_FLOAT_TYPE y);
|
||||
|
||||
/**
|
||||
@brief Get the number of demand categories for a node.
|
||||
@param nodeIndex The index of a node (first node is index 1)
|
||||
@param[out] numDemands The number of demand categories
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetnumdemands(int nodeIndex, int *numDemands);
|
||||
int DLLEXPORT ENgetbasedemand(int nodeIndex, int demandIdx, EN_API_FLOAT_TYPE *baseDemand);
|
||||
int DLLEXPORT ENgetdemandpattern(int nodeIndex, int demandIdx, int *pattIdx);
|
||||
|
||||
/**
|
||||
@brief Get a node's base demand for a specified category.
|
||||
@param nodeIndex The index of a node (first node is index 1)
|
||||
@param demandIndex The index of the demand category (starting at 1)
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetbasedemand(int nodeIndex, int demandIndex, EN_API_FLOAT_TYPE *baseDemand);
|
||||
|
||||
/**
|
||||
@brief Get the index of the demand pattern assigned to a node for a category index.
|
||||
@param nodeIndex The index of a node (first node is index 1).
|
||||
@param demandIndex The index of a category (first category is index 1).
|
||||
@param[out] pattIndex The index of the pattern for this node and category.
|
||||
@return Error code
|
||||
*/
|
||||
int DLLEXPORT ENgetdemandpattern(int nodeIndex, int demandIndex, int *pattIndex);
|
||||
|
||||
/**
|
||||
@brief Get the index of a Link with specified ID.
|
||||
@param id The string ID of a link.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Get the string ID of a link with specified index
|
||||
@param index The index of a link (first link is index 1)
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Get the link type code for a specified link
|
||||
@param index The index of a link (first link is index 1)
|
||||
@param[out] code The type code of the link.
|
||||
@return Error code
|
||||
@see EN_LinkType
|
||||
*/
|
||||
int DLLEXPORT ENgetlinktype(int index, int *code);
|
||||
|
||||
/**
|
||||
@brief Get the indexes of a link's start- and end-nodes.
|
||||
@param index The index of a link (first link is index 1)
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Get a property value for specified link.
|
||||
@param index The index of a node (first node is index 1).
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Get a curve's properties.
|
||||
@param curveIndex The index of a curve (first curve is index 1).
|
||||
@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 ENgetheadcurveindex(int index, int *curveindex);
|
||||
int DLLEXPORT ENgetpumptype(int index, int *type);
|
||||
|
||||
/**
|
||||
@brief Retrieves the curve index for a specified pump index.
|
||||
@param pumpIndex The index of a pump
|
||||
@param[out] curveIndex The index of the curve used by the pump.
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENgetheadcurveindex(int pumpIndex, int *curveIndex);
|
||||
|
||||
/**
|
||||
@brief Get the type of pump
|
||||
@param linkIndex The index of the pump element
|
||||
@param[out] outType The integer-typed pump curve type signifier (output parameter)
|
||||
@return Error code
|
||||
@see EN_CurveType
|
||||
*/
|
||||
int DLLEXPORT ENgetpumptype(int linkIndex, int *outType);
|
||||
|
||||
/**
|
||||
@brief Get the version number. This number is to be interpreted with implied decimals, i.e., "20100" == "2(.)01(.)00"
|
||||
@param[out] version The version of EPANET
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENgetversion(int *version);
|
||||
|
||||
/**
|
||||
@brief Specify parameters to define a simple control
|
||||
@param cindex The index of the control to edit. First control is index 1.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Set a property value for a node.
|
||||
@param index The index of a node. First node is index 1.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Set a proprty value for a link.
|
||||
@param index The index of a link. First link is index 1.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Add a new time pattern.
|
||||
@param id The string ID of the pattern to add.
|
||||
@return Error code.
|
||||
@see ENgetpatternindex
|
||||
*/
|
||||
int DLLEXPORT ENaddpattern(char *id);
|
||||
|
||||
/**
|
||||
@brief Set multipliers for a specific pattern
|
||||
@param index The index of a pattern. First pattern is index 1.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Set the multiplier for a specific pattern at a specific period.
|
||||
@param index The index of a pattern. First pattern is index 1.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Set the value for a time parameter.
|
||||
@param code The code for the parameter to set.
|
||||
@param value The desired value of the parameter.
|
||||
@return Error code.
|
||||
@see EN_TimeProperty
|
||||
*/
|
||||
int DLLEXPORT ENsettimeparam(int code, long value);
|
||||
|
||||
/**
|
||||
@brief Set a value for an anlysis option.
|
||||
@param code The code for the desired option.
|
||||
@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);
|
||||
|
||||
/**
|
||||
@brief Sets the level of hydraulic status reporting.
|
||||
@param code Status reporting code.
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENsetstatusreport(int code);
|
||||
|
||||
/**
|
||||
@brief Sets type of quality analysis called for
|
||||
@param qualcode WQ parameter code, EN_QualityType
|
||||
@param chemname Name of WQ constituent
|
||||
@param chemunits Concentration units of WQ constituent
|
||||
@param tracenode ID of node being traced (if applicable)
|
||||
@return Error code.
|
||||
@see EN_QualityType
|
||||
|
||||
chemname and chemunits only apply when WQ analysis is for chemical. tracenode only applies when WQ analysis is source tracing.
|
||||
*/
|
||||
int DLLEXPORT ENsetqualtype(int qualcode, char *chemname, char *chemunits, char *tracenode);
|
||||
|
||||
/**
|
||||
@brief Get quality analysis information (type, chemical name, units, trace node ID)
|
||||
@param[out] qualcode The EN_QualityType code being used.
|
||||
@param[out] chemname The name of the WQ constituent.
|
||||
@param[out] chemunits The cencentration units of the WQ constituent.
|
||||
@param[out] tracenode The trace node ID.
|
||||
@return Error code.
|
||||
@see EN_QualityType
|
||||
*/
|
||||
int DLLEXPORT ENgetqualinfo(int *qualcode, char *chemname, char *chemunits, int *tracenode);
|
||||
|
||||
/**
|
||||
@brief Sets the node's base demand for a category.
|
||||
@param nodeIndex The index of a node.
|
||||
@param demandIdx The index of a demand category.
|
||||
@param baseDemand The base demand multiplier for the selected category.
|
||||
@return Error code.
|
||||
@see ENgetbasedemand
|
||||
*/
|
||||
int DLLEXPORT ENsetbasedemand(int nodeIndex, int demandIdx, EN_API_FLOAT_TYPE baseDemand);
|
||||
|
||||
|
||||
/**
|
||||
@brief Retrieves index of curve with specific ID.
|
||||
@param id The ID of a curve.
|
||||
@param[out] index The index of the named curve
|
||||
@return Error code.
|
||||
@see ENgetcurveid
|
||||
*/
|
||||
int DLLEXPORT ENgetcurveindex(char *id, int *index);
|
||||
|
||||
/**
|
||||
@brief Retrieves ID of a curve with specific index.
|
||||
@param index The index of a curve.
|
||||
@param[out] id The ID of the curve specified.
|
||||
@return Error code.
|
||||
@see ENsetcurveindex
|
||||
|
||||
NOTE: 'id' must be able to hold MAXID characters
|
||||
*/
|
||||
int DLLEXPORT ENgetcurveid(int index, char *id);
|
||||
|
||||
/**
|
||||
@brief Retrieves number of points in a curve
|
||||
@param index The index of a curve.
|
||||
@param[out] len The length of the curve coordinate list
|
||||
@return Error code.
|
||||
@see ENgetcurvevalue
|
||||
*/
|
||||
int DLLEXPORT ENgetcurvelen(int index, int *len);
|
||||
int DLLEXPORT ENgetcurvevalue(int index, int pnt, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y);
|
||||
int DLLEXPORT ENsetcurvevalue(int index, int pnt, EN_API_FLOAT_TYPE x, EN_API_FLOAT_TYPE y);
|
||||
|
||||
/**
|
||||
@brief retrieves x,y point for a specific point number and curve
|
||||
@param curveIndex The index of a curve
|
||||
@param pointIndex The index of a point in the curve
|
||||
@param[out] x The x-value of the specified point.
|
||||
@param[out] y The y-value of the specified point.
|
||||
@return Error code.
|
||||
@see ENgetcurvelen ENsetcurvevalue
|
||||
*/
|
||||
int DLLEXPORT ENgetcurvevalue(int curveIndex, int pointIndex, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y);
|
||||
|
||||
/**
|
||||
@brief Sets x,y point for a specific point and curve.
|
||||
@param curveIndex The index of a curve.
|
||||
@param pointIndex The index of a point in the curve.
|
||||
@param x The x-value of the point.
|
||||
@param y The y-value of the point.
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENsetcurvevalue(int curveIndex, int pointIndex, EN_API_FLOAT_TYPE x, EN_API_FLOAT_TYPE y);
|
||||
|
||||
/**
|
||||
@brief Sets x,y values for a specified curve.
|
||||
@param index The index of a curve.
|
||||
@param x An array of x-values for the curve.
|
||||
@param y An array of y-values for the curve.
|
||||
@param len The length of the arrays x and y.
|
||||
@return Error code.
|
||||
*/
|
||||
int DLLEXPORT ENsetcurve(int index, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y, int len);
|
||||
|
||||
/**
|
||||
@brief Adds a new curve appended to the end of the existing curves.
|
||||
@param id The name of the curve to be added.
|
||||
@return Error code.
|
||||
@see ENgetcurveindex ENsetcurve
|
||||
*/
|
||||
int DLLEXPORT ENaddcurve(char *id);
|
||||
|
||||
#if defined(__cplusplus)
|
||||
|
||||
Reference in New Issue
Block a user