util::RegionArrayOption Class Reference

Hold a N-dim Region. More...

Inherits util::Option.

Public Member Functions
	RegionArrayOption (const char *name, const char *defaultVal, const char *usage, const char &cmd, const int &N, Region *const =NULL)
	RegionArrayOption (const string &name, const string &defaultVal, const string &usage, const char &cmd, const int &N, Region *const =NULL)
	~RegionArrayOption () throw ()
virtual string	getTypeName () const
	Return the type name of the option as a string. More...
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. More...
virtual Region	getRegionArray () const
virtual string	toString () const
	Return the option's value as a string. More...
string	toRegionString () const
virtual bool	needsValue () const
const string &	getName () const
	Return the (long) option name. More...
char	getCmdLineChar () const
	Return the short option char. More...
const string &	getDefault () const
	Return the string representation of the default value. More...
const string &	getUsage () const
	Return the help string. More...
virtual int	getInt () const
virtual float	getFloat () const
virtual string	getString () const
virtual bool	getBool () const

Protected Attributes
const int	N_
Region *	storage_
Region	value_
string	name_
	long option name (e.g. –long-option or long-option=value) More...
string	default_
	string representation of default value More...
string	usage_
	help string More...
char	cmdlinechar_
	short option char, for command line use More...

Related Functions
(Note that these are not member functions.)
ostream &	operator<< (ostream &os, Option &op)

Detailed Description

Hold a N-dim Region.

Constructor & Destructor Documentation

util::RegionArrayOption::RegionArrayOption	(	const char *	name,
		const char *	defaultVal,
		const char *	usage,
		const char &	cmd,
		const int &	N,
		Region *	const = NULL
	)

util::RegionArrayOption::RegionArrayOption	(	const string &	name,
		const string &	defaultVal,
		const string &	usage,
		const char &	cmd,
		const int &	N,
		Region *	const = NULL
	)

util::RegionArrayOption::~RegionArrayOption ( ) throw ( )

inline

Member Function Documentation

virtual string util::RegionArrayOption::getTypeName ( ) const

inlinevirtual

Return the type name of the option as a string.

Reimplemented from util::Option.

void util::RegionArrayOption::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 Region util::RegionArrayOption::getRegionArray ( ) const

virtual

virtual string util::RegionArrayOption::toString ( ) const

virtual

Return the option's value as a string.

Implements util::Option.

string util::RegionArrayOption::toRegionString

(

)

const

virtual int util::Option::getInt ( ) const

inlinevirtualinherited

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

Reimplemented in util::IntOption.

virtual float util::Option::getFloat ( ) const

inlinevirtualinherited

Reimplemented in util::FloatOption.

virtual string util::Option::getString ( ) const

inlinevirtualinherited

Reimplemented in util::StringOption.

virtual bool util::Option::getBool ( ) const

inlinevirtualinherited

Reimplemented in util::BoolOption.

virtual bool util::Option::needsValue ( ) const

inlinevirtualinherited

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

const int util::RegionArrayOption::N_

protected

Region* util::RegionArrayOption::storage_

protected

Region util::RegionArrayOption::value_

protected

string util::Option::name_

protectedinherited

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

string util::Option::default_

protectedinherited

string representation of default value

string util::Option::usage_

protectedinherited

help string

char util::Option::cmdlinechar_

protectedinherited

short option char, for command line use