Updates the docs
This commit is contained in:
Lew Rossman
@@ -4,16 +4,16 @@ The Input file is a standard EPANET input data file that describes the system be
|
||||
|
||||
The file is organized by sections where each section begins with a keyword enclosed in brackets. The various keywords are listed below. Click on a section to see the format of the data it contains.
|
||||
|
||||
|Network Components |System Operation |Water Quality |Options & Reporting |
|
||||
|:-------------------------------|:-------------------------------|:--------------------------------|:-------------------------------|
|
||||
|@subpage TitlePage "[Title]" |@subpage CurvesPage "[Curves]" |@subpage QualPage "[Quality]" |@subpage OptionsPage "[Options]"|
|
||||
|@subpage JuncsPage "[Junctions]"|@subpage PatsPage "[Patterns]" |@subpage ReactsPage "[Reactions]"|@subpage TimesPage "[Times]" |
|
||||
|@subpage ResvPage "[Reservoirs]"|@subpage EnergyPage "[Energy]" |@subpage SourcesPage "[Sources]" |@subpage ReportPage "[Report]" |
|
||||
|@subpage TanksPage "[Tanks]" |@subpage StatusPage "[Status]" |@subpage MixingPage "[Mixing]" | |
|
||||
|@subpage PipesPage "[Pipes]" |@subpage CtrlsPage "[Controls]" | | |
|
||||
|@subpage PumpsPage "[Pumps]" |@subpage RulesPage "[Rules]" | | |
|
||||
|@subpage ValvesPage "[Valves]" |@subpage DmndsPage "[Demands]" | | |
|
||||
|@subpage EmitsPage "[Emitters]" | | | |
|
||||
|Network Components |System Operation |Water Quality |Options & Reporting |GUI Support |
|
||||
|:-------------------------------|:-------------------------------|:--------------------------------|:-------------------------------|------------------------------------|
|
||||
|@subpage TitlePage "[Title]" |@subpage CurvesPage "[Curves]" |@subpage QualPage "[Quality]" |@subpage OptionsPage "[Options]"|@subpage BackdropPage "[Backdrop]" |
|
||||
|@subpage JuncsPage "[Junctions]"|@subpage PatsPage "[Patterns]" |@subpage ReactsPage "[Reactions]"|@subpage TimesPage "[Times]" |@subpage CoordsPage "[Coordinates]" |
|
||||
|@subpage ResvPage "[Reservoirs]"|@subpage EnergyPage "[Energy]" |@subpage SourcesPage "[Sources]" |@subpage ReportPage "[Report]" |@subpage VertexPage "[Vertices]" |
|
||||
|@subpage TanksPage "[Tanks]" |@subpage StatusPage "[Status]" |@subpage MixingPage "[Mixing]" | |@subpage LabelsPage "[Labels]" |
|
||||
|@subpage PipesPage "[Pipes]" |@subpage CtrlsPage "[Controls]" | | | |
|
||||
|@subpage PumpsPage "[Pumps]" |@subpage RulesPage "[Rules]" | | | |
|
||||
|@subpage ValvesPage "[Valves]" |@subpage DmndsPage "[Demands]" | | | |
|
||||
|@subpage EmitsPage "[Emitters]" | | | | |
|
||||
|
||||
The order of sections is not important. However, whenever a node or link is referred to in a section it must have already been defined in the [JUNCTIONS], [RESERVOIRS], [TANKS], [PIPES], [PUMPS], or [VALVES] sections. Thus it is recommended that these sections be placed first.
|
||||
|
||||
@@ -21,6 +21,8 @@ Each section can contain one or more lines of data. Blank lines can appear anywh
|
||||
|
||||
The ID labels used to identify nodes, links, curves and patterns can be any combination of up to 31 characters and numbers.
|
||||
|
||||
The GUI Support sections are provided to assist an external program that wishes to draw a visual representation of a project's network.
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
@@ -1040,3 +1042,111 @@ __Remarks:__
|
||||
|<B>GPV</B> (general purpose valve) | ID of head loss curve |
|
||||
2. Shutoff valves and check valves are considered to be part of a pipe, not a separate control valve component (see @ref PipesPage).
|
||||
*/
|
||||
|
||||
/**
|
||||
@page BackdropPage [BACKDROP]
|
||||
|
||||
__Purpose:__
|
||||
|
||||
Identifies a backdrop image and dimensions for visualizing the network's layout.
|
||||
|
||||
__Formats:__
|
||||
<table style = "border: 0px solid black">
|
||||
<tr> <td><b>DIMENSIONS</b></td> <td><I>LLx LLy URx URy</I></td> </tr>
|
||||
<tr> <td><b>UNITS</b></td> <td><b>FEET/METERS/DEGREES/NONE</b></td> </tr>
|
||||
<tr> <td><b>FILE</b></td><td><I>filename</I></td> </tr>
|
||||
<tr> <td><b>OFFSET</b></td><td><I>X Y</I></td> </tr>
|
||||
</table>
|
||||
|
||||
__Definitions:__
|
||||
|
||||
<b>DIMENSIONS</b> provides the X and Y coordinates of the lower-left and upper-right corners of the network's
|
||||
bounding rectangle. Defaults are the extents of the nodal coordinates supplied in the @ref CoordsPage "[COORDINATES]" section.
|
||||
|
||||
<b>UNITS</b> specifies the units that the network's dimensions are given in. Default is <b>NONE</b>.
|
||||
|
||||
<b>FILE</b> supplies the name of the file that contains a backdrop image for the network.
|
||||
|
||||
<b>OFFSET</b> lists the X and Y distance that the upper-left corner of the backdrop image is offset from the
|
||||
upper-left corner of the network’s bounding rectangle. Default is zero offset.
|
||||
|
||||
__Remarks:__
|
||||
|
||||
1. The [BACKDROP] section is optional and only provides support for an external GUI program that uses the EPANET engine.
|
||||
|
||||
2. Only Windows Enhanced Metafiles and bitmap files can be used as backdrops.
|
||||
*/
|
||||
|
||||
/**
|
||||
@page CoordsPage [COORDINATES]
|
||||
|
||||
__Purpose:__
|
||||
|
||||
Assigns map coordinates to network's nodes.
|
||||
|
||||
__Format__:
|
||||
|
||||
One line for each node containing:
|
||||
- Node ID label
|
||||
- X-coordinate
|
||||
- Y-coordinate
|
||||
|
||||
__Remarks:__
|
||||
|
||||
1. Include one line for each node that has coordinates.
|
||||
|
||||
2. The coordinates represent the distance from the node to an arbitrary origin at the lower left of the network. Any convenient units of measure for this distance can be used.
|
||||
|
||||
3. The locations of the nodes need not be to actual scale.
|
||||
|
||||
4. A [COORDINATES] section is optional and only provides support for an external GUI program that uses the EPANET engine.
|
||||
*/
|
||||
|
||||
/**
|
||||
@page VertexPage [VERTICES]
|
||||
|
||||
__Purpose:__
|
||||
|
||||
Assigns interior vertex points that describe the shape of network links.
|
||||
|
||||
__Format:__
|
||||
|
||||
One line for each vertex point in each link containing such points that includes:
|
||||
- Link ID label
|
||||
- X-coordinate
|
||||
- Y-coordinate
|
||||
|
||||
__Remarks:__
|
||||
|
||||
1. Vertex points allow links to be drawn as polylines instead of simple straight-lines between their end nodes.
|
||||
|
||||
2. The coordinates refer to the same coordinate system used for node and label coordinates.
|
||||
|
||||
3. A [VERTICES] section is optional and only provides support for an external GUI program that uses the EPANET engine.
|
||||
*/
|
||||
|
||||
/**
|
||||
@page LabelsPage [LABELS]
|
||||
|
||||
__Purpose:__
|
||||
|
||||
Assigns coordinates to labels added to a network's visualization.
|
||||
|
||||
__Format:__
|
||||
|
||||
One line for each label containing:
|
||||
- X-coordinate
|
||||
- Y-coordinate
|
||||
- Text of label in double quotes
|
||||
- ID label of an anchor node (optional)
|
||||
|
||||
__Remarks:__
|
||||
|
||||
1. Include one line for each label.
|
||||
|
||||
2. The coordinates refer to the upper left corner of the label and are with respect to an arbitrary origin at the lower left of the network.
|
||||
|
||||
3. The optional anchor node anchors the label to the node when the network layout is re-scaled during zoom-in operations.
|
||||
|
||||
4. The [LABELS] section is optional and only provides support for an external GUI program that uses the EPANET engine.
|
||||
*/
|
||||
|
||||
@@ -120,6 +120,8 @@ These are the toolkit's enumerated types whose members are used as function argu
|
||||
@fn int EN_getversion(int *version)
|
||||
@fn int EN_geterror(int errcode, char *errmsg, int maxLen)
|
||||
@fn int EN_getstatistic(EN_Project ph, int type, double* value)
|
||||
@fn int EN_getresultindex(EN_Project ph, int type, int index, int *value)
|
||||
|
||||
@}
|
||||
*/
|
||||
|
||||
@@ -193,6 +195,9 @@ These are the toolkit's enumerated types whose members are used as function argu
|
||||
@fn int EN_getpumptype(EN_Project ph, int linkIndex, int *pumpType)
|
||||
@fn int EN_getheadcurveindex(EN_Project ph, int pumpIndex, int *curveIndex)
|
||||
@fn int EN_setheadcurveindex(EN_Project ph, int pumpIndex, int curveIndex)
|
||||
@fn int EN_getvertexcount(EN_Project ph, int index, int *count)
|
||||
@fn int EN_getvertex(EN_Project ph, int index, int vertex, double *x, double *y)
|
||||
@fn int EN_setvertices(EN_Project ph, int index, double *x, double *y, int count)
|
||||
@}
|
||||
*/
|
||||
|
||||
|
||||
@@ -151,7 +151,7 @@ The Toolkit provides several header files that are needed to develop C/C++ appli
|
||||
- <b>`epanet2_2.h`</b> contains declarations of the multi-threaded version of the Toolkit (the EN_xxx named functions).
|
||||
- <b>`epanet2_enums.h`</b> contains definitions of the symbolic constants used by the Toolkit.
|
||||
- <b>`epanet2.lib`</b> must be linked in to any Toolkit application compiled for Windows using MS Visual C++.
|
||||
Developers need to issue an `#include` directive for either `epanet2.h` or `epanet2_2.h` in their C/C++ code depending on whether they are building a single-threaded or multi-threaded application. There is no need to explicitly include `epanet2_enums.h` as it is automatically included by both of the other header files.
|
||||
Developers need to issue an include directive for either `epanet2.h` or `epanet2_2.h` in their C/C++ code depending on whether they are building a single-threaded or multi-threaded application. There is no need to explicitly include `epanet2_enums.h` as it is automatically included by both of the other header files.
|
||||
|
||||
Several additional function declaration files that provide bindings for other programming languages are included with the Toolkit package:
|
||||
- <b>`epanet2.bas`</b> for Visual Basic for Applications and Visual Basic 6
|
||||
|
||||
Reference in New Issue
Block a user