ENgettimeparam: Get the value of one or more specific analysis time...

Description Usage Arguments Details Value Examples

View source: R/times.r

Description

ENgettimeparam retrieves the value of one or more specific analysis time parameters.

Usage

1
ENgettimeparam(paramcode)

Arguments

paramcode

A character string or integer specifying the parameter code (see below).

Details

Time parameter codes consist of the following constants:

EN_DURATION 0 Simulation duration
EN_HYDSTEP 1 Hydraulic time step
EN_QUALSTEP 2 Water quality time step
EN_PATTERNSTEP 3 Time pattern time step
EN_PATTERNSTART 4 Time pattern start time
EN_REPORTSTEP 5 Reporting time step
EN_REPORTSTART 6 Report starting time
EN_RULESTEP 7 Time step for evaluating rule-based controls
EN_STATISTIC 8 Type of time series post-processing used:
0 = none
1 = averaged
2 = minimums
3 = maximums
4 = ranges
EN_PERIODS 9 Number of reporting periods saved to binary output file

Value

A named integer with the value of the specified time parameter.

Examples

1
2
3
4
5
6
# path to Net1.inp example file included with this package 
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp") 
ENopen(inp, "Net1.rpt")
ENgettimeparam("EN_DURATION")
ENgettimeparam("EN_HYDSTEP")
ENclose()

epanet2toolkit documentation built on July 28, 2018, 1:06 a.m.