TCLAP::MultiArg< T > Class Template Reference

#include <MultiArg.h>

Inherited by TCLAP::UnlabeledMultiArg< T >.

Collaboration diagram for TCLAP::MultiArg< T >:

Public Member Functions
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, 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::vector< T > &allowed, Visitor *v=NULL)
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::vector< T > &allowed, CmdLineInterface &parser, Visitor *v=NULL)
virtual bool	processArg (int *i, std::vector< std::string > &args)
const std::vector< T > &	getValue ()
virtual std::string	shortID (const std::string &val="val") const
virtual std::string	longID (const std::string &val="val") const
virtual bool	isRequired () const
Protected Member Functions
void	_extractValue (const std::string &val)
void	_checkAllowed (const std::string &val)
Protected Attributes
std::vector< T >	_values
std::vector< T >	_allowed
std::string	_typeDesc

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.

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.

template<class T >

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

template<class T >

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

Member Function Documentation

template<class T >

void TCLAP::MultiArg< T >::_checkAllowed ( const std::string & val ) [inline, protected]

Checks to see if parsed value is in allowed list.

Parameters:

val

- value parsed (only used in output).

Checks to see if the value parsed is in the allowed list.

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.

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.

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.

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

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

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

Member Data Documentation

template<class T >

std::vector<T> TCLAP::MultiArg< 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 TCLAP::MultiArg< T >::_typeDesc [protected]

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

template<class T >

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

The list of values parsed from the CmdLine.

TCLAP::MultiArg< T > Class Template Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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