ENgetqualtype: Retrieve the type of water quality analysis called for.

View source: R/Rtoolkit.R View source: R/quality.r

ENgetqualtypeR Documentation

Retrieve the type of water quality analysis called for.

Description

ENgetqualtype retrieves the type of water quality analysis called for.

Usage

ENgetqualtype()

ENgetqualtype()

Value

A named integer vector, the water quality analysis code (see below) and the index of node traced in a source tracing analysis.

list of qualcode and trace node

Note

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

The tracenode value will be 0 when the quality code is not EN_TRACE.

See Also

ENsetqualtype

Examples

# path to Net1.inp example file included with this package
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp")  
ENopen( inp, "Net1.rpt")
ENgetqualtype()
ENclose()
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp")  
ENopen( inp, "Net1.rpt")
ENgetqualtype()
ENclose()
# clean-up the created files
file.remove("Net1.rpt") 

epanet2toolkit documentation built on Nov. 6, 2023, 9:06 a.m.