TCLAP::UnlabeledValueArg< T > Class Template Reference

The basic unlabeled argument that parses a value. More...

#include <UnlabeledValueArg.h>

Inheritance diagram for TCLAP::UnlabeledValueArg< T >:

[legend]Collaboration diagram for TCLAP::UnlabeledValueArg< T >:

[legend]List of all members.

Public Member Functions
	UnlabeledValueArg (const std::string &name, const std::string &desc, T value, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)
	Constructor implemenation.
	UnlabeledValueArg (const std::string &name, const std::string &desc, T value, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
	UnlabeledValueArg constructor.
	UnlabeledValueArg (const std::string &name, const std::string &desc, T value, const std::vector< T > &allowed, bool ignoreable=false, Visitor *v=NULL)
	Constructor implemenation.
	UnlabeledValueArg (const std::string &name, const std::string &desc, T value, const std::vector< T > &allowed, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
	UnlabeledValueArg constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Implementation of processArg().
virtual std::string	shortID (const std::string &val="val") const
	Overriding shortID for specific output.
virtual std::string	longID (const std::string &val="val") const
	Overriding longID for specific output.
virtual bool	operator== (const Arg &a) const
	Overriding operator== for specific behavior.
virtual void	addToList (std::list< Arg * > &argList) const
	Instead of pushing to the front of list, push to the back.

---

Detailed Description

template<class T>
class TCLAP::UnlabeledValueArg< T >

The basic unlabeled argument that parses a value.

This is a template class, which means the type T defines the type that a given object will attempt to parse when an UnlabeledValueArg is reached in the list of args that the CmdLine iterates over.

---

Constructor & Destructor Documentation

template<class T>

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

Constructor implemenation.

Note that this constructor does not have a required flag. Any unlabeled argument added to the CmdLine is by default required. If you want optional, unlabeled arguments then use an UnlabeledMultiArg.

Parameters:

	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.
	value	- The default value assigned to this argument if it is not present 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	- Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
	v	- Optional Vistor. You should leave this blank unless you have a very good reason.

template<class T>

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

UnlabeledValueArg constructor.

Note that this constructor does not have a required flag. Any unlabeled argument added to the CmdLine is by default required. If you want optional, unlabeled arguments then use an UnlabeledMultiArg.

Parameters:

	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.
	value	- The default value assigned to this argument if it is not present 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	- Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
	v	- Optional Vistor. You should leave this blank unless you have a very good reason.

template<class T>

TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg	(	const std::string &	name,
		const std::string &	desc,
		T	value,
		const std::vector< T > &	allowed,
		bool	ignoreable = false,
		Visitor *	v = NULL
	)

Constructor implemenation.

Note that this constructor does not have a required flag. Any unlabeled argument added to the CmdLine is by default required. If you want optional, unlabeled arguments then use an UnlabeledMultiArg.

Parameters:

	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.
	value	- The default value assigned to this argument if it is not present 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.
	ignoreable	- Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
	v	- Optional Vistor. You should leave this blank unless you have a very good reason.

template<class T>

TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg	(	const std::string &	name,
		const std::string &	desc,
		T	value,
		const std::vector< T > &	allowed,
		CmdLineInterface &	parser,
		bool	ignoreable = false,
		Visitor *	v = NULL
	)

UnlabeledValueArg constructor.

Note that this constructor does not have a required flag. Any unlabeled argument added to the CmdLine is by default required. If you want optional, unlabeled arguments then use an UnlabeledMultiArg.

Parameters:

	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.
	value	- The default value assigned to this argument if it is not present 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
	ignoreable	- Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored.
	v	- Optional Vistor. You should leave this blank unless you have a very good reason.

---

Member Function Documentation

template<class T>

void TCLAP::UnlabeledValueArg< T >::addToList

(

std::list< Arg * > &

argList

)

const [virtual]

Instead of pushing to the front of list, push to the back.

Parameters:

argList

- The list to add this to.

Reimplemented from TCLAP::Arg.

template<class T>

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

(

const std::string &

val = "val"

)

const [virtual]

Overriding longID for specific output.

Reimplemented from TCLAP::ValueArg< T >.

template<class T>

bool TCLAP::UnlabeledValueArg< T >::operator==

(

const Arg &

a

)

const [virtual]

Overriding operator== for specific behavior.

template<class T>

bool TCLAP::UnlabeledValueArg< T >::processArg	(	int *	i,
		std::vector< std::string > &	args
	)			[virtual]

Implementation of processArg().

This re-implements the Arg version of this method to set the _value of the argument appropriately. Handling specific to unlabled arguments.

Parameters:

	i	- Pointer the the current argument in the list.
	args	- Mutable list of strings.

Reimplemented from TCLAP::ValueArg< T >.

template<class T>

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

(

const std::string &

val = "val"

)

const [virtual]

Overriding shortID for specific output.

Reimplemented from TCLAP::ValueArg< T >.

---

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

• tclap/UnlabeledValueArg.h

---