ENgetpatternid {epanet2toolkit}

Retrieve the ID label a time pattern

Description

ENgetpatternid retrieves the ID label of a particular time pattern.

Usage

ENgetpatternid(patternindex)

Arguments

patternindex

An integer specifying the time pattern index.

Value

A character string, the pattern ID label 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")
ENgetpatternid(1)
ENclose()