ENgetpatternindex: Retrieve the index a time pattern.

View source: R/patterns.r

ENgetpatternindexR Documentation

Retrieve the index a time pattern.

Description

ENgetpatternindex retrieves the index of a time pattern.

Usage

ENgetpatternindex(patternid)

Arguments

patternid

A character string specifying the pattern ID

Value

An integer, the index of the specified time pattern.

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")
ENgetpatternindex("1")
ENclose()

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