ENgetpatternvalue: Retrieve the multiplier factor for a specific time period

In epanet2toolkit: Call 'EPANET' Functions to Simulate Pipe Networks

Retrieve the multiplier factor for a specific time period

Description

ENgetpatternvalue retrieves the multiplier factor for specific time periods in a pattern.

Usage

ENgetpatternvalue(index, period)

Arguments

index	An integer specifying the time pattern index.
period	An integer or integer vector of the periods within the time pattern.

Value

A numeric or numeric vector, the multiplier factor for the specific time pattern and period.

Note

Pattern indexes and periods are consecutive integers starting from 1.

See Also

ENgetpatternindex, ENgetpatternlen, ENsetpatternvalue

Examples

# path to Net1.inp example file included with this package
inp <- file.path( find.package("epanet2toolkit"), "extdata","Net1.inp")  
ENopen( inp, "Net1.rpt")
ENgetpatternvalue(1,1)
ENgetpatternvalue(1,2)
ENgetpatternvalue(1,3)
ENclose()

epanet2toolkit documentation built on May 29, 2024, 8:40 a.m.