TCLAP::MultiArg< T > Class Template Reference

#include <MultiArg.h>

Inheritance diagram for TCLAP::MultiArg< T >:

List of all members.

Public Member Functions
virtual bool	allowMore ()
const std::vector< T > &	getValue ()
virtual std::string	getValueAsString () const
virtual bool	isRequired () const
virtual std::string	longID (const std::string &val="val") const
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL)
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, Visitor *v=NULL)
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, Visitor *v=NULL)
virtual bool	processArg (int *i, std::vector< std::string > &args)
virtual std::string	shortID (const std::string &val="val") const
Protected Member Functions
void	_extractValue (const std::string &val)
Protected Attributes
bool	_allowMore
Constraint< T > *	_constraint
std::string	_typeDesc
std::vector< T >	_values

---

Detailed Description

template<class T>
class TCLAP::MultiArg< T >

An argument that allows multiple values of type T to be specified. Very similar to a ValueArg, except a vector of values will be returned instead of just one.

---

Constructor & Destructor Documentation

template<class T >

TCLAP::MultiArg< T >::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		const std::string &	typeDesc,
		Visitor *	v = NULL
	)			[inline]

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

References TCLAP::Arg::_acceptsMultipleValues.

template<class T >

TCLAP::MultiArg< T >::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		const std::string &	typeDesc,
		CmdLineInterface &	parser,
		Visitor *	v = NULL
	)			[inline]

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

References TCLAP::Arg::_acceptsMultipleValues, and TCLAP::CmdLineInterface::add().

template<class T >

TCLAP::MultiArg< T >::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		Visitor *	v = NULL
	)			[inline]

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

References TCLAP::Arg::_acceptsMultipleValues.

template<class T >

TCLAP::MultiArg< T >::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		CmdLineInterface &	parser,
		Visitor *	v = NULL
	)			[inline]

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

References TCLAP::Arg::_acceptsMultipleValues, and TCLAP::CmdLineInterface::add().

---

Member Function Documentation

template<class T >

void TCLAP::MultiArg< T >::_extractValue

(

const std::string &

val

)

[inline, protected]

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

Parameters:

val

- The string to be read.

References TCLAP::MultiArg< T >::_constraint, TCLAP::MultiArg< T >::_values, TCLAP::MULTI_ARG_HELPER::EXTRACT_FAILURE, TCLAP::MULTI_ARG_HELPER::EXTRACT_TOO_MANY, TCLAP::MULTI_ARG_HELPER::ValueExtractor< T >::extractValue(), and TCLAP::Arg::toString().

Referenced by TCLAP::UnlabeledMultiArg< T >::processArg(), and TCLAP::MultiArg< T >::processArg().

template<class T >

bool TCLAP::MultiArg< T >::allowMore

(

)

[inline, virtual]

Reimplemented from TCLAP::Arg.

References TCLAP::MultiArg< T >::_allowMore.

template<class T >

const std::vector< T > & TCLAP::MultiArg< T >::getValue

(

)

[inline]

Returns a vector of type T containing the values parsed from the command line.

References TCLAP::MultiArg< T >::_values.

Referenced by main(), and parseOptions().

template<class T >

std::string TCLAP::MultiArg< T >::getValueAsString

(

)

const [inline, virtual]

Implements TCLAP::Arg.

References TCLAP::MultiArg< T >::_values.

template<class T >

bool TCLAP::MultiArg< T >::isRequired

(

)

const [inline, virtual]

Once we've matched the first value, then the arg is no longer required.

Reimplemented from TCLAP::Arg.

References TCLAP::Arg::_required, and TCLAP::MultiArg< T >::_values.

template<class T >

std::string TCLAP::MultiArg< T >::longID

(

const std::string &

val = "val"

)

const [inline, virtual]

Returns the a long id string. Used in the usage.

Parameters:

val

- value to be used.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

References TCLAP::MultiArg< T >::_typeDesc.

template<class T >

bool TCLAP::MultiArg< T >::processArg	(	int *	i,
		std::vector< std::string > &	args
	)			[inline, 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 from main().

Implements TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

References TCLAP::Arg::_alreadySet, TCLAP::Arg::_checkWithVisitor(), TCLAP::MultiArg< T >::_extractValue(), TCLAP::Arg::_hasBlanks(), TCLAP::Arg::_ignoreable, TCLAP::Arg::argMatches(), TCLAP::Arg::delimiter(), TCLAP::Arg::ignoreRest(), TCLAP::Arg::toString(), and TCLAP::Arg::trimFlag().

template<class T >

std::string TCLAP::MultiArg< T >::shortID

(

const std::string &

val = "val"

)

const [inline, virtual]

Returns the a short id string. Used in the usage.

Parameters:

val

- value to be used.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

References TCLAP::MultiArg< T >::_typeDesc.

---

Member Data Documentation

template<class T>

bool TCLAP::MultiArg< T >::_allowMore [protected]

Referenced by TCLAP::MultiArg< T >::allowMore().

template<class T>

Constraint<T>* TCLAP::MultiArg< T >::_constraint [protected]

A list of constraint on this Arg.

Referenced by TCLAP::MultiArg< T >::_extractValue().

template<class T>

std::string TCLAP::MultiArg< T >::_typeDesc [protected]

The description of type T to be used in the usage.

Referenced by TCLAP::UnlabeledMultiArg< T >::longID(), TCLAP::MultiArg< T >::longID(), TCLAP::UnlabeledMultiArg< T >::shortID(), and TCLAP::MultiArg< T >::shortID().

template<class T>

std::vector<T> TCLAP::MultiArg< T >::_values [protected]

The list of values parsed from the CmdLine.

Referenced by TCLAP::MultiArg< T >::_extractValue(), TCLAP::MultiArg< T >::getValue(), TCLAP::MultiArg< T >::getValueAsString(), and TCLAP::MultiArg< T >::isRequired().

---

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

• Libs/SlicerExecutionModel/tclap/include/tclap/MultiArg.h