util::Option Class Reference
[Command Line and Config File Interfacing]

The base class for all options. More...

Inherited by util::BoolOption, util::DoubleArrayOption, util::DoubleOption, util::FloatArrayOption, util::FloatOption, util::IntArrayOption, util::IntOption, util::RegionArrayOption, util::StringArrayOption, and util::StringOption.

List of all members.

Public Member Functions

Protected Attributes

Related Functions

(Note that these are not member functions.)

Detailed Description

The base class for all options.

All data is stored as strings. Conversion (parsing) to the actual type happens in derived specializations.

Constructing an option requires 4 (+1) parameters:


Constructor & Destructor Documentation

util::Option::Option ( const char *  name,
const char *  defaultVal,
const char *  usage,
const char  cmd 
)

util::Option::Option ( const string &  name,
const string &  defaultVal,
const string &  usage,
const char  cmd 
)

virtual util::Option::~Option (  )  throw () [virtual]


Member Function Documentation

virtual void util::Option::setValue ( const string &  s  )  throw (UException) [pure virtual]

Implemented in util::IntOption, util::FloatOption, util::DoubleOption, util::BoolOption, util::StringOption, util::FloatArrayOption, util::DoubleArrayOption, util::IntArrayOption, util::StringArrayOption, and util::RegionArrayOption.

virtual int util::Option::getInt (  )  const [inline, virtual]

Reimplemented in util::IntOption.

virtual float util::Option::getFloat (  )  const [inline, virtual]

Reimplemented in util::FloatOption.

virtual string util::Option::getString (  )  const [inline, virtual]

Reimplemented in util::StringOption.

virtual bool util::Option::getBool (  )  const [inline, virtual]

Reimplemented in util::BoolOption.

virtual string util::Option::getTypeName (  )  const [inline, virtual]

Reimplemented in util::IntOption, util::FloatOption, util::DoubleOption, util::BoolOption, util::StringOption, util::FloatArrayOption, util::DoubleArrayOption, util::IntArrayOption, util::StringArrayOption, and util::RegionArrayOption.

virtual bool util::Option::needsValue (  )  const [inline, virtual]

Reimplemented in util::BoolOption.

const string& util::Option::getName (  )  const

char util::Option::getCmdLineChar (  )  const

const string& util::Option::getDefault (  )  const

const string& util::Option::getUsage (  )  const

virtual string util::Option::toString (  )  const [pure virtual]

Implemented in util::IntOption, util::FloatOption, util::DoubleOption, util::BoolOption, util::StringOption, util::FloatArrayOption, util::DoubleArrayOption, util::IntArrayOption, util::StringArrayOption, and util::RegionArrayOption.


Member Data Documentation

string util::Option::name_ [protected]

string util::Option::default_ [protected]

string util::Option::usage_ [protected]

char util::Option::cmdlinechar_ [protected]


Generated on Wed Mar 11 17:44:37 2009 for LTL by  doxygen 1.5.3