#include <ValueArg.h>

Inheritance diagram for TCLAP::ValueArg< T >:

Public Member Functions
T &	getValue ()

virtual std::string	longID (const std::string &val="val") const

virtual bool	processArg (int *i, std::vector< std::string > &args)

virtual void	reset ()

virtual std::string	shortID (const std::string &val="val") const

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

	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)

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

	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, Constraint< T > constraint, Visitor v=NULL)

Public Member Functions inherited from TCLAP::Arg
bool	_hasBlanks (const std::string &s) const

virtual bool	acceptsMultipleValues ()

virtual void	addToList (std::list< Arg * > &argList) const

virtual bool	allowMore ()

virtual bool	argMatches (const std::string &s) const

void	forceRequired ()

std::string	getDescription () const

const std::string &	getFlag () const

const std::string &	getName () const

bool	isIgnoreable () const

virtual bool	isRequired () const

bool	isSet () const

bool	isValueRequired () const

virtual bool	operator== (const Arg &a) const

void	setRequireLabel (const std::string &s)

virtual std::string	toString () const

virtual void	trimFlag (std::string &flag, std::string &value) const

void	xorSet ()

virtual	~Arg ()

Protected Member Functions
void	_extractValue (const std::string &val)

Protected Member Functions inherited from TCLAP::Arg
void	_checkWithVisitor () const

	Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)

Protected Attributes
Constraint< T > *	_constraint

T	_default

std::string	_typeDesc

T	_value

Protected Attributes inherited from TCLAP::Arg
bool	_acceptsMultipleValues

bool	_alreadySet

std::string	_description

std::string	_flag

bool	_ignoreable

std::string	_name

bool	_required

std::string	_requireLabel

bool	_valueRequired

Visitor *	_visitor

bool	_xorSet

Private Member Functions
ValueArg< T > &	operator= (const ValueArg< T > &rhs)

	ValueArg (const ValueArg< T > &rhs)

Additional Inherited Members
Static Public Member Functions inherited from TCLAP::Arg
static void	beginIgnoring ()

static char	blankChar ()

static char	delimiter ()

static char	flagStartChar ()

static const std::string	flagStartString ()

static const std::string	ignoreNameString ()

static bool	ignoreRest ()

static const std::string	nameStartString ()

static void	setDelimiter (char c)

Detailed Description

template<class T>
class TCLAP::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.

Definition at line 43 of file ValueArg.h.

Constructor & Destructor Documentation

template<class T >

TCLAP::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	val,
		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.

Constructor implementation.

Definition at line 252 of file ValueArg.h.

template<class T >

TCLAP::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.

Definition at line 267 of file ValueArg.h.

template<class T >

TCLAP::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		Constraint< T > *	constraint,
		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.
constraint	- A pointer to a Constraint object used to constrain this 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.

Definition at line 300 of file ValueArg.h.

template<class T >

TCLAP::ValueArg< T >::ValueArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		T	value,
		Constraint< T > *	constraint,
		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.
constraint	- A pointer to a Constraint object used to constrain this Arg.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 285 of file ValueArg.h.

template<class T>

TCLAP::ValueArg< T >::ValueArg ( const ValueArg< T > & rhs )

private

Prevent accidental copying

Member Function Documentation

template<class T >

void TCLAP::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.

Definition at line 400 of file ValueArg.h.

template<class T >

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

Returns the value of the argument.

Implementation of getValue().

Definition at line 322 of file ValueArg.h.

template<class T >

std::string TCLAP::ValueArg< T >::longID ( const std::string & val = "val" ) const

virtual

Specialization of longID.

Parameters

val	- value to be used.

Implementation of longID.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 393 of file ValueArg.h.

template<class T>

ValueArg<T>& TCLAP::ValueArg< T >::operator= ( const ValueArg< T > & rhs )

private

template<class T >

bool TCLAP::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().

Implementation of processArg().

Implements TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 328 of file ValueArg.h.

template<class T >

void TCLAP::ValueArg< T >::reset ( void )

virtual

Clears the Arg object and allows it to be reused by new command lines.

Reimplemented from TCLAP::Arg.

Definition at line 417 of file ValueArg.h.

template<class T >

std::string TCLAP::ValueArg< T >::shortID ( const std::string & val = "val" ) const

virtual

Specialization of shortID.

Parameters

val	- value to be used.

Implementation of shortID.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 383 of file ValueArg.h.

Member Data Documentation

template<class T>

Constraint<T>* TCLAP::ValueArg< T >::_constraint

protected

A Constraint this Arg must conform to.

Definition at line 72 of file ValueArg.h.

template<class T>

T TCLAP::ValueArg< T >::_default

protected

Used to support the reset() method so that ValueArg can be reset to their constructed value.

Definition at line 58 of file ValueArg.h.

template<class T>

std::string TCLAP::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.

Definition at line 67 of file ValueArg.h.

template<class T>

T TCLAP::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.

Definition at line 52 of file ValueArg.h.

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

ValueArg.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<class T> class TCLAP::ValueArg< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class TCLAP::ValueArg< T >