#include <MultiArg.h>

Inheritance diagram for TCLAP::MultiArg< T >:

Public Types
typedef container_type::const_iterator	const_iterator

typedef std::vector< T >	container_type

typedef container_type::iterator	iterator

Public Member Functions
virtual bool	allowMore ()

const_iterator	begin () const

const_iterator	end () const

const std::vector< T > &	getValue ()

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, 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, Constraint< T > constraint, Visitor v=NULL)

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

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

virtual void	reset ()

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

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

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
bool	_allowMore

Constraint< T > *	_constraint

std::string	_typeDesc

std::vector< T >	_values

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
	MultiArg (const MultiArg< T > &rhs)

MultiArg< T > &	operator= (const MultiArg< 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::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.

Definition at line 39 of file MultiArg.h.

Member Typedef Documentation

template<class T>

typedef container_type::const_iterator TCLAP::MultiArg< T >::const_iterator

Definition at line 44 of file MultiArg.h.

template<class T>

typedef std::vector<T> TCLAP::MultiArg< T >::container_type

Definition at line 42 of file MultiArg.h.

template<class T>

typedef container_type::iterator TCLAP::MultiArg< T >::iterator

Definition at line 43 of file MultiArg.h.

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`
	)

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.

Definition at line 234 of file MultiArg.h.

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`
	)

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.

Definition at line 250 of file MultiArg.h.

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`
	)

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.

Definition at line 271 of file MultiArg.h.

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`
	)

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.

Definition at line 287 of file MultiArg.h.

template<class T>

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

private

Prevent accidental copying

Member Function Documentation

template<class T >

void TCLAP::MultiArg< 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	- The string to be read.

Definition at line 398 of file MultiArg.h.

template<class T >

bool TCLAP::MultiArg< T >::allowMore ( )

virtual

Used for MultiArgs and XorHandler to determine whether args can still be set.

Reimplemented from TCLAP::Arg.

Definition at line 417 of file MultiArg.h.

template<class T>

const_iterator TCLAP::MultiArg< T >::begin ( void ) const

inline

Returns an iterator over the values parsed from the command line.

Definition at line 194 of file MultiArg.h.

template<class T>

const_iterator TCLAP::MultiArg< T >::end ( void ) const

inline

Returns the end of the values parsed from the command line.

Definition at line 200 of file MultiArg.h.

template<class T >

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

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

Definition at line 305 of file MultiArg.h.

template<class T >

bool TCLAP::MultiArg< T >::isRequired ( ) const

virtual

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

Reimplemented from TCLAP::Arg.

Definition at line 383 of file MultiArg.h.

template<class T >

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

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

Definition at line 372 of file MultiArg.h.

template<class T>

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

private

template<class T >

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

Implements TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

Definition at line 308 of file MultiArg.h.

template<class T >

void TCLAP::MultiArg< 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 425 of file MultiArg.h.

template<class T >

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

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

Definition at line 362 of file MultiArg.h.

Member Data Documentation

template<class T>

bool TCLAP::MultiArg< T >::_allowMore

protected

Used by XorHandler to decide whether to keep parsing for this arg.

Definition at line 74 of file MultiArg.h.

template<class T>

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

protected

A list of constraint on this Arg.

Definition at line 61 of file MultiArg.h.

template<class T>

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

protected

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

Definition at line 56 of file MultiArg.h.

template<class T>

std::vector<T> TCLAP::MultiArg< T >::_values

protected

The list of values parsed from the CmdLine.

Definition at line 51 of file MultiArg.h.

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

MultiArg.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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