#include <UnlabeledMultiArg.h>

Inheritance diagram for TCLAP::UnlabeledMultiArg< T >:

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

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

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

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

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

	UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)

	UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)

	UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, Constraint< T > constraint, bool ignoreable=false, Visitor v=NULL)

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

Public Member Functions inherited from TCLAP::MultiArg< T >
virtual bool	allowMore ()

const_iterator	begin () const

const_iterator	end () const

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

virtual bool	isRequired () 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 void	reset ()

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

virtual bool	acceptsMultipleValues ()

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

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

Additional Inherited Members
Public Types inherited from TCLAP::MultiArg< T >
typedef container_type::const_iterator	const_iterator

typedef std::vector< T >	container_type

typedef container_type::iterator	iterator

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)

Protected Member Functions inherited from TCLAP::MultiArg< T >
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 inherited from TCLAP::MultiArg< T >
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

Detailed Description

template<class T>
class TCLAP::UnlabeledMultiArg< T >

Just like a MultiArg, except that the arguments are unlabeled. Basically, this Arg will slurp up everything that hasn't been matched to another Arg.

Definition at line 40 of file UnlabeledMultiArg.h.

Constructor & Destructor Documentation

template<class T >

TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		bool	req,
		const std::string &	typeDesc,
		bool	ignoreable = `false`,
		Visitor *	v = `NULL`
	)

Constructor.

Parameters

name	- The name of the Arg. Note that this is used for identification, not as a long flag.
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.
ignoreable	- Whether or not this argument can be ignored using the "--" flag.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 187 of file UnlabeledMultiArg.h.

template<class T >

TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		bool	req,
		const std::string &	typeDesc,
		CmdLineInterface &	parser,
		bool	ignoreable = `false`,
		Visitor *	v = `NULL`
	)

Constructor.

Parameters

name	- The name of the Arg. Note that this is used for identification, not as a long flag.
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
ignoreable	- Whether or not this argument can be ignored using the "--" flag.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 200 of file UnlabeledMultiArg.h.

template<class T >

TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		bool	ignoreable = `false`,
		Visitor *	v = `NULL`
	)

Constructor.

Parameters

name	- The name of the Arg. Note that this is used for identification, not as a long flag.
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.
ignoreable	- Whether or not this argument can be ignored using the "--" flag.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 216 of file UnlabeledMultiArg.h.

template<class T >

TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		CmdLineInterface &	parser,
		bool	ignoreable = `false`,
		Visitor *	v = `NULL`
	)

Constructor.

Parameters

name	- The name of the Arg. Note that this is used for identification, not as a long flag.
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
ignoreable	- Whether or not this argument can be ignored using the "--" flag.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 229 of file UnlabeledMultiArg.h.

Member Function Documentation

template<class T >

void TCLAP::UnlabeledMultiArg< T >::addToList ( std::list< Arg * > & argList ) const

virtual

Pushes this to back of list rather than front.

Parameters

argList - The list this should be added to.

Reimplemented from TCLAP::Arg.

Definition at line 294 of file UnlabeledMultiArg.h.

template<class T >

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

Definition at line 278 of file UnlabeledMultiArg.h.

template<class T >

bool TCLAP::UnlabeledMultiArg< T >::operator== ( const Arg & a ) const

virtual

Opertor ==.

Parameters

a	- The Arg to be compared to this.

Reimplemented from TCLAP::Arg.

Definition at line 285 of file UnlabeledMultiArg.h.

template<class T >

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

Reimplemented from TCLAP::MultiArg< T >.

Definition at line 245 of file UnlabeledMultiArg.h.

template<class T >

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

Definition at line 271 of file UnlabeledMultiArg.h.

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

UnlabeledMultiArg.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class TCLAP::UnlabeledMultiArg< T >

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class TCLAP::UnlabeledMultiArg< T >