DtCmdLine::UnlabeledValueArg< T > Class Template Reference

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

Inheritance diagram for DtCmdLine::UnlabeledValueArg< T >:

Collaboration diagram for DtCmdLine::UnlabeledValueArg< T >:

Public Member Functions
	UnlabeledValueArg (const std::string &name, const std::string &desc, T value, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)
	UnlabeledValueArg constructor.
	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)
	UnlabeledValueArg constructor.
	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)
	Handles the processing of the argument.
virtual std::string	shortID (const std::string &val="val") const
	Overrides shortID for specific behavior.
virtual std::string	longID (const std::string &val="val") const
	Overrides longID for specific behavior.
virtual bool	operator== (const Arg &a) const
	Overrides operator== for specific behavior.
virtual void	addToList (std::list< Arg * > &argList) const
	Instead of pushing to the front of list, push to the back.
Public Member Functions inherited from DtCmdLine::ValueArg< T >
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::vector< T > &allowed, CmdLineInterface &parser, Visitor *v=NULL)
	Labeled ValueArg constructor.
	ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::vector< T > &allowed, Visitor *v=NULL)
	Labeled ValueArg constructor.
const T &	getValue () const
	Returns the value of the argument.
T &	getValue ()
	Returns the value of the argument.
void	setValue (const T &val)
	sets The Value of the argument.
T *	getInternalPtrValue ()
	Returns a pointer to the internal storage for this class This is useful for MTL and other not so smart readers.
	operator T & ()
	allow for implicit conversion to my native type
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.
virtual bool	isRequired () const
	Indicates whether the argument is required.
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::ValueArg< 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.
void	allowedInit ()
	Common initialization code for constructors with allowed vectors.
Protected Attributes inherited from DtCmdLine::ValueArg< T >
T	_value
	The value parsed from the command line.
std::vector< T >	_allowed
	A list of allowed values.
std::string	_typeDesc
	A human readable description of the type to be parsed.

Detailed Description

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

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

UnlabeledValueArg constructor.

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.

References DtCmdLine::Arg::_ignoreable.

template<class T >

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

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

template<class T >

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

UnlabeledValueArg constructor.

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.

References DtCmdLine::Arg::_ignoreable.

template<class T >

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

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

Member Function Documentation

template<class T >

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

template<class T >

std::string DtCmdLine::UnlabeledValueArg< T >::longID ( const std::string &  val = "val" ) const

virtual

Overrides longID for specific behavior.

Overriding longID for specific output.

Reimplemented from DtCmdLine::ValueArg< T >.

template<class T >

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

virtual

Overrides operator== for specific behavior.

Overriding operator== for specific behavior.

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

template<class T >

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

virtual

Handles the processing of the argument.

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

template<class T >

std::string DtCmdLine::UnlabeledValueArg< T >::shortID ( const std::string &  val = "val" ) const

virtual

Overrides shortID for specific behavior.

Overriding shortID for specific output.

Reimplemented from DtCmdLine::ValueArg< T >.

---

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

• cmdUnlabeledValueArg.h