ENgetoption: Retrieve the value of an analysis option.

View source: R/options.r

ENgetoptionR Documentation

Retrieve the value of an analysis option.

Description

ENgetoption retrieves the value of one or more particular analysis options.

Usage

ENgetoption(optioncode)

Arguments

optioncode

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

Details

Option codes consist of the following constants:

EN_TRIALS 0
EN_ACCURACY 1
EN_TOLERANCE 2
EN_EMITEXPON 3
EN_DEMANDMULT 4

Value

numeric value of the specified analysis option(s).

Examples

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

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