The "getWhatever" member functions of Param convert the internal Strings into the desired output data type. The Strings themselves may also be returned.
// we will create a Param which contains the boundary for an iteration loop. String key("IterBound"); // give "IterBound" a default value String value("200"); // a help String for prompting String help("The Boundary value for the chutzpah iterator."); // The expected return type is an integer String type("Int"); // The range of "legal" values String range("10-10000"); // the units of the value String unit("unitless"): // Now we may build our Param Param PleaseDontTouchMeThere(key, value, help, type, range, unit); // to retrieve the value we use the GetInt function for (Int i=0, i<PleaseDontTouchMeThere.getInt(); i++, chutzpah++);
normal constructor with optional value and help strings
copy constructor
destructor
assignment operator
Equality comparitor
This function ALWAYS returns false. I have no idea why it was designed to do this.
I/O operators
get a double parameter value; prompt if switch is TRUE
get a Block
get an Int parameter value; prompt if switch is TRUE
get an Block
get a String parameter value; prompt if switch is TRUE
get a Block
get a Boolean parameter value; prompt if switch is TRUE
get parameter value as a string
get parameter help string
get parameter name
get the string `key = value' for the parameter
get the type of a parameter
get the valid range of a parameter
get the units of a parameter
set new parameter value; return FALSE if invalid value
set a parameter as a system parameter
check if a parameter is a system parameter
set an index for a program parameter
get the index of a parameter
Int getInt (Bool do_prompt=False) const
Block<Int> getIntArray (Bool do_prompt=False) const
const String& getString (Bool do_prompt=False) const
Block<String> getStringArray (Bool do_prompt=False) const
Bool getBool (Bool do_prompt=False) const
const String& get() const
const String& getHelp() const
const String& getKey() const
String keyVal() const
const String& getType() const
const String& getRange() const
const String& getUnit() const
Bool put (const String& a_value)
void setSystem (Bool val)
Bool isSystem() const
void setIndex (Int inx)
Int getIndex() const