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

Hold an integer number. More...

Inherits util::Option.

List of all members.

Public Member Functions

• IntOption (const char *name, const char *defaultVal, const char *usage, const char cmd, int *const storage=NULL)
• IntOption (const string &name, const string &defaultVal, const string &usage, const char cmd, int *const storage=NULL)
• ~IntOption () throw ()
• virtual string getTypeName () const

  Return the type name of the option as a string.
  

• void setValue (const string &s) throw (UException)

  This function is the heart of the Option class: it parses the value of the option from the supplied string.
  

• virtual int getInt () const
• virtual string toString () const

  Return the option's value as a string.
  

• virtual bool needsValue () const
• const string & getName () const

  Return the (long) option name.
  

• char getCmdLineChar () const

  Return the short option char.
  

• const string & getDefault () const

  Return the string representation of the default value.
  

• const string & getUsage () const

  Return the help string.
  

• virtual float getFloat () const
• virtual string getString () const
• virtual bool getBool () const

Protected Attributes

• int value_
• int * storage_
• string name_

  long option name (e.g. --long-option or long-option=value)
  

• string default_

  string representation of default value
  

• string usage_

  help string
  

• char cmdlinechar_

  short option char, for command line use
  

Related Functions

(Note that these are not member functions.)

• ostream & operator<< (ostream &os, Option &op)

---

Detailed Description

Hold an integer number.

These are the specializations for various types and arrays of types. Each of these implements overloads the parser function:

 void setValue( const string& s ); 

and the accessor function(s) returning the appropriate type.

The constructors have a further parameter which is a pointer to the option's (native) type. The option will also write its value to that location if the pointer is not NULL; Useful for easily setting global parameters, or filling a struct with parameter values without having to manually loop over and read all program option's values.

---

Constructor & Destructor Documentation

util::IntOption::IntOption	(	const char *	name,
		const char *	defaultVal,
		const char *	usage,
		const char	cmd,
		int *const	storage = NULL
	)

util::IntOption::IntOption	(	const string &	name,
		const string &	defaultVal,
		const string &	usage,
		const char	cmd,
		int *const	storage = NULL
	)

util::IntOption::~IntOption

(

)

throw () [inline]

---

Member Function Documentation

virtual string util::IntOption::getTypeName

(

)

const [inline, virtual]

Return the type name of the option as a string.

Reimplemented from util::Option.

void util::IntOption::setValue

(

const string &

s

)

throw (UException) [virtual]

This function is the heart of the Option class: it parses the value of the option from the supplied string.

Implements util::Option.

virtual int util::IntOption::getInt

(

)

const [virtual]

Acess the value of the option. Usually subclasses will not implement all of these, in fact, mostly just one of these.

Reimplemented from util::Option.

virtual string util::IntOption::toString

(

)

const [virtual]

Return the option's value as a string.

Implements util::Option.

virtual float util::Option::getFloat

(

)

const [inline, virtual, inherited]

Reimplemented in util::FloatOption.

virtual string util::Option::getString

(

)

const [inline, virtual, inherited]

Reimplemented in util::StringOption.

virtual bool util::Option::getBool

(

)

const [inline, virtual, inherited]

Reimplemented in util::BoolOption.

virtual bool util::Option::needsValue

(

)

const [inline, virtual, inherited]

Return true if the option needs a value, false if it is a toggle-switch needing no value. On the command line, values are given as --long-option value, or -x value. In a config file, long-option = value. '#' can be used to delineate comments. See CommandLineReader and ConfigFileReader.

Reimplemented in util::BoolOption.

const string& util::Option::getName

(

)

const [inherited]

Return the (long) option name.

char util::Option::getCmdLineChar

(

)

const [inherited]

Return the short option char.

const string& util::Option::getDefault

(

)

const [inherited]

Return the string representation of the default value.

const string& util::Option::getUsage

(

)

const [inherited]

Return the help string.

---

Member Data Documentation

int util::IntOption::value_ [protected]

int* util::IntOption::storage_ [protected]

string util::Option::name_ [protected, inherited]

long option name (e.g. --long-option or long-option=value)

string util::Option::default_ [protected, inherited]

string representation of default value

string util::Option::usage_ [protected, inherited]

help string

char util::Option::cmdlinechar_ [protected, inherited]

short option char, for command line use