ENsetqualtype {epanet2toolkit} | R Documentation |
Set the type of water quality analysis called for.
Description
ENsetqualtype
sets the type of water quality analysis called for.
Usage
ENsetqualtype(qualcode, chemname = "", chemunits = "", tracenode = "")
Arguments
qualcode |
An integer or a character string, the water quality analysis code (see below). |
chemname |
A character string, the name of the chemical being analyzed. |
chemunits |
A character string, units that the chemical is measured in. |
tracenode |
A character string, ID of node traced in a source tracing analysis. |
Details
Water quality analysis codes are as follows:
EN_NONE | 0 | No quality analysis |
EN_CHEM | 1 | Chemical analysis |
EN_AGE | 2 | Water age analysis |
EN_TRACE | 3 | Source tracing |
Chemical name and units can be an empty string if the analysis is not for a chemical. The same holds for the trace node if the analysis is not for source tracing. Note that the trace node is specified by ID and not by index.
Value
returns NULL invisibly on success
See Also
ENgetqualtype
Examples
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp")
ENopen( inp, "Net1.rpt")
ENgetqualtype()
ENsetqualtype("EN_CHEM", "Chlorine", "mg/L", "")
ENgetqualtype()
ENclose()
# clean-up the created files
file.remove("Net1.rpt")
[Package epanet2toolkit version 1.0.5 Index]