Just like a MultiArg, except that the arguments are unlabeled. More...

Inheritance diagram for DtCmdLine::UnlabeledMultiArg< T >:

Collaboration diagram for DtCmdLine::UnlabeledMultiArg< T >:

Public Member Functions
	UnlabeledMultiArg (const std::string &name, const std::string &desc, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)
	Constructor.
	UnlabeledMultiArg (const std::string &name, const std::string &desc, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
	Constructor.
	UnlabeledMultiArg (const std::string &name, const std::string &desc, const std::vector< T > &allowed, bool ignoreable=false, Visitor *v=NULL)
	Constructor.
	UnlabeledMultiArg (const std::string &name, const std::string &desc, const std::vector< T > &allowed, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
	Constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument.
virtual std::string	shortID (const std::string &val="val") const
	Returns the a short id string.
virtual std::string	longID (const std::string &val="val") const
	Returns the a long id string.
virtual bool	operator== (const Arg &a) const
	Opertor ==.
virtual void	addToList (std::list< Arg * > &argList) const
	Pushes this to back of list rather than front.
Public Member Functions inherited from DtCmdLine::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.
	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.
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::vector< T > &allowed, Visitor *v=NULL)
	Constructor.
	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)
	Constructor.
const std::vector< T > &	getValue () const
	Returns a vector of type T containing the values parsed from the command line.
virtual bool	isRequired () const
	Once we've matched the first value, then the arg is no longer required.
Public Member Functions inherited from DtCmdLine::Arg
virtual	~Arg ()
	Destructor.
virtual bool	operator== (const Arg &a)
	Operator ==.
const std::string &	getFlag () const
	Returns the argument flag.
const std::string &	getName () const
	Returns the argument name.
std::string	getDescription () const
	Returns the argument description.
void	forceRequired ()
	Sets _required to true.
void	xorSet ()
	Sets the _alreadySet value to true.
bool	isValueRequired () const
	Indicates whether a value must be specified for argument.
bool	isSet () const
	Indicates whether the argument has already been set.
bool	isIgnoreable () const
	Indicates whether the argument can be ignored, if desired.
virtual bool	argMatches (const std::string &s) const
	A method that tests whether a string matches this argument.
virtual std::string	toString () const
	Returns a simple string representation of the argument.
virtual void	trimFlag (std::string &flag, std::string &value) const
	Trims a value off of the flag.
bool	_hasBlanks (const std::string &s) const
	Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.
void	setRequireLabel (const std::string &s)
	Sets the requireLabel.

Additional Inherited Members
Static Public Member Functions inherited from DtCmdLine::Arg
static void	beginIgnoring ()
	Begin ignoring arguments since the "–" argument was specified.
static bool	ignoreRest ()
	Whether to ignore the rest.
static char	delimiter ()
	The delimiter that separates an argument flag/name from the value.
static const char	blankChar ()
	The char used as a place holder when SwitchArgs are combined.
static const char	flagStartChar ()
	The char that indicates the beginning of a flag.
static const std::string	flagStartString ()
	The sting that indicates the beginning of a flag.
static const std::string	nameStartString ()
	The sting that indicates the beginning of a name.
static const std::string	ignoreNameString ()
	The name used to identify the ignore rest argument.
static void	setDelimiter (char c)
	Sets the delimiter for all arguments.
Protected Member Functions inherited from DtCmdLine::MultiArg< T >
void	_extractValue (const std::string &val)
	Extracts the value from the string.
void	_checkAllowed (const std::string &val)
	Checks to see if parsed value is in allowed list.
Protected Attributes inherited from DtCmdLine::MultiArg< T >
std::vector< T >	_values
	The list of values parsed from the CmdLine.
std::vector< T >	_allowed
	A list of allowed values.
std::string	_typeDesc
	The description of type T to be used in the usage.

Detailed Description

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

Constructor & Destructor Documentation

template<class T >

DtCmdLine::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		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.
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.

References DtCmdLine::Arg::_ignoreable.

template<class T >

DtCmdLine::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		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.
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.

References DtCmdLine::Arg::_ignoreable, and DtCmdLine::CmdLineInterface::add().

template<class T >

DtCmdLine::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		const std::vector< T > &	allowed,
		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.
allowed	- A vector of type T that where the values in the vector are the only values allowed for the 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.

References DtCmdLine::Arg::_ignoreable.

template<class T >

DtCmdLine::UnlabeledMultiArg< T >::UnlabeledMultiArg	(	const std::string &	name,
		const std::string &	desc,
		const std::vector< T > &	allowed,
		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.
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
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.

References DtCmdLine::Arg::_ignoreable, and DtCmdLine::CmdLineInterface::add().

Member Function Documentation

template<class T >

void DtCmdLine::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 DtCmdLine::Arg.

template<class T >

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

template<class T >

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

virtual

Opertor ==.

Parameters

a	- The Arg to be compared to this.

References DtCmdLine::Arg::getDescription(), and DtCmdLine::Arg::getName().

template<class T >

bool DtCmdLine::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