ENgetpatternlen: Retrieve the number of time periods in a time pattern.

View source: R/patterns.r

ENgetpatternlenR Documentation

Retrieve the number of time periods in a time pattern.

Description

ENgetpatternlen retrieves the number of time periods in a specific time pattern.

Usage

ENgetpatternlen(patternindex)

Arguments

patternindex

An integer specifying a time pattern index.

Value

An integer, the time pattern length.

Note

Pattern indexes are consecutive integers starting from 1.

Examples

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

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