The basic labeled argument that parses a value. More...

Inheritance diagram for DtCmdLine::ValueArg< T >:

Collaboration diagram for DtCmdLine::ValueArg< T >:

Public Member Functions
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::vector< T > &allowed, CmdLineInterface &parser, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::vector< T > &allowed, Visitor *v=NULL)
	Labeled ValueArg constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument.
const T &	getValue () const
	Returns the value of the argument.
T &	getValue ()
	Returns the value of the argument.
void	setValue (const T &val)
	sets The Value of the argument.
T *	getInternalPtrValue ()
	Returns a pointer to the internal storage for this class This is useful for MTL and other not so smart readers.
	operator T & ()
	allow for implicit conversion to my native type
virtual std::string	shortID (const std::string &val="val") const
	Specialization of shortID.
virtual std::string	longID (const std::string &val="val") const
	Specialization of longID.
Protected Member Functions
void	_extractValue (const std::string &val)
	Extracts the value from the string.
void	_checkAllowed (const std::string &val)
	Checks to see if parsed value is in allowed list.
void	allowedInit ()
	Common initialization code for constructors with allowed vectors.
Protected Attributes
T	_value
	The value parsed from the command line.
std::vector< T >	_allowed
	A list of allowed values.
std::string	_typeDesc
	A human readable description of the type to be parsed.

Detailed Description

template<class T>
class DtCmdLine::ValueArg< T >

The basic labeled argument that parses a value.

This is a template class, which means the type T defines the type that a given object will attempt to parse when the flag/name is matched on the command line. While there is nothing stopping you from creating an unflagged ValueArg, it is unwise and would cause significant problems. Instead use an UnlabeledValueArg.

Constructor & Destructor Documentation

template<class T>

DtCmdLine::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		const std::string &	typeDesc,
		Visitor *	v = `NULL`
	)

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
req	- Whether the argument is required on the command line.
value	- The default value assigned to this argument if it is not present on the command line.
typeDesc	- A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

template<class T>

DtCmdLine::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		const std::string &	typeDesc,
		CmdLineInterface &	parser,
		Visitor *	v = `NULL`
	)

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
req	- Whether the argument is required on the command line.
value	- The default value assigned to this argument if it is not present on the command line.
typeDesc	- A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program.
parser	- A CmdLine parser object to add this Arg to
v	- An optional visitor. You probably should not use this unless you have a very good reason.

template<class T>

DtCmdLine::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		const std::vector< T > &	allowed,
		CmdLineInterface &	parser,
		Visitor *	v = `NULL`
	)

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
req	- Whether the argument is required on the command line.
value	- The default value assigned to this argument if it is not present on the command line.
allowed	- A vector of type T that where the values in the vector are the only values allowed for the arg.
parser	- A CmdLine parser object to add this Arg to.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

template<class T>

DtCmdLine::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		const std::vector< T > &	allowed,
		Visitor *	v = `NULL`
	)

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
name	- A one word name for the argument. Can be used as a long flag on the command line.
desc	- A description of what the argument is for or does.
req	- Whether the argument is required on the command line.
value	- The default value assigned to this argument if it is not present on the command line.
allowed	- A vector of type T that where the values in the vector are the only values allowed for the arg.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Member Function Documentation

template<class T>

void DtCmdLine::ValueArg< T >::_checkAllowed ( const std::string & val ) [protected]

Checks to see if parsed value is in allowed list.

Parameters:

val	- value parsed (only used in output).

template<class T>

void DtCmdLine::ValueArg< T >::_extractValue ( const std::string & val ) [protected]

Extracts the value from the string.

Attempts to parse string as type T, if this fails an exception is thrown.

Parameters:

val	- value to be parsed.

template<class T>

void DtCmdLine::ValueArg< T >::allowedInit ( ) [protected]

Common initialization code for constructors with allowed vectors.

template<class T>

T* DtCmdLine::ValueArg< T >::getInternalPtrValue ( )

Returns a pointer to the internal storage for this class This is useful for MTL and other not so smart readers.

Referenced by DtMtlEnvironment::registerCmdLineVar().

template<class T>

const T& DtCmdLine::ValueArg< T >::getValue ( ) const

Returns the value of the argument.

template<class T>

T& DtCmdLine::ValueArg< T >::getValue ( )

Returns the value of the argument.

template<class T>

virtual std::string DtCmdLine::ValueArg< T >::longID ( const std::string & val = "val" ) const [virtual]

Specialization of longID.

Parameters:

val	- value to be used.

Reimplemented from DtCmdLine::Arg.

Reimplemented in DtCmdLine::UnlabeledValueArg< T >.

template<class T>

DtCmdLine::ValueArg< T >::operator T & ( )

allow for implicit conversion to my native type

template<class T>

virtual bool DtCmdLine::ValueArg< T >::processArg	(	int *	i,
		std::vector< std::string > &	args
	)		`[virtual]`

Handles the processing of the argument.

This re-implements the Arg version of this method to set the _value of the argument appropriately. It knows the difference between labeled and unlabeled.

Parameters:

i	- Pointer the the current argument in the list.
args	- Mutable list of strings. Passed in from main().

Implements DtCmdLine::Arg.

Reimplemented in DtCmdLine::UnlabeledValueArg< T >.

template<class T>

void DtCmdLine::ValueArg< T >::setValue ( const T & val )

sets The Value of the argument.

template<class T>

virtual std::string DtCmdLine::ValueArg< T >::shortID ( const std::string & val = "val" ) const [virtual]

Specialization of shortID.

Parameters:

val	- value to be used.

Reimplemented from DtCmdLine::Arg.

Reimplemented in DtCmdLine::UnlabeledValueArg< T >.

Member Data Documentation

template<class T>

std::vector<T> DtCmdLine::ValueArg< T >::_allowed [protected]

A list of allowed values.

A list of values allowed for this argument. If the value parsed for this arg is not found in this list, then an exception is thrown. If the list is empty, then any value is allowed.

template<class T>

std::string DtCmdLine::ValueArg< T >::_typeDesc [protected]

A human readable description of the type to be parsed.

This is a hack, plain and simple. Ideally we would use RTTI to return the name of type T, but until there is some sort of consistent support for human readable names, we are left to our own devices.

template<class T>

T DtCmdLine::ValueArg< T >::_value [protected]

The value parsed from the command line.

Can be of any type, as long as the >> operator for the type is defined.

The documentation for this class was generated from the following file:

cmdValueArg.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class T> class DtCmdLine::ValueArg< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class DtCmdLine::ValueArg< T >