TCLAP::Arg Class Reference

A virtual base class that defines the essential data for all arguments. More...

#include <Arg.h>

Inheritance diagram for TCLAP::Arg:

[legend]Collaboration diagram for TCLAP::Arg:

[legend]List of all members.

Public Member Functions
virtual	~Arg ()
	Destructor.
virtual void	addToList (std::list< Arg * > &argList) const
	Overridden by Args that need to added to the end of the list.
virtual bool	processArg (int *i, std::vector< std::string > &args)=0
	Pure virtual method meant to handle the parsing and value assignment of the string on the command line.
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 std::string	shortID (const std::string &valueId="val") const
	Returns a short ID for the usage.
virtual std::string	longID (const std::string &valueId="val") const
	Returns a long ID for the usage.
virtual void	trimFlag (std::string &flag, std::string &value) const
	Implementation of trimFlag.
bool	_hasBlanks (const std::string &s) const
	Implementation of _hasBlanks.
void	setRequireLabel (const std::string &s)
	Sets the requireLabel.
Static Public Member Functions
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
void	_checkWithVisitor () const
	Performs the special handling described by the Vistitor.
	Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL)
	Primary constructor.
Protected Attributes
std::string	_flag
	The single char flag used to identify the argument.
std::string	_name
	A single work namd indentifying the argument.
std::string	_description
	Description of the argument.
bool	_required
	Indicating whether the argument is required.
std::string	_requireLabel
	Label to be used in usage description.
bool	_valueRequired
	Indicates whether a value is required for the argument.
bool	_alreadySet
	Indicates whether the argument has been set.
Visitor *	_visitor
	A pointer to a vistitor object.
bool	_ignoreable
	Whether this argument can be ignored, if desired.
bool	_xorSet
	Indicates that the arg was set as part of an XOR and not on the command line.
Static Private Member Functions
static bool &	ignoreRestRef ()
	Indicates whether the rest of the arguments should be ignored.
static char &	delimiterRef ()
	The delimiter that separates an argument flag/name from the value.

---

Detailed Description

A virtual base class that defines the essential data for all arguments.

This class, or one of its existing children, must be subclassed to do anything.

---

Constructor & Destructor Documentation

TCLAP::Arg::Arg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		bool	valreq,
		Visitor *	v = NULL
	)			[inline, protected]

Primary constructor.

YOU (yes you) should NEVER construct an Arg directly, this is a base class that is extended by various children that are meant to be used. Use SwitchArg, ValueArg, MultiArg, UnlabeledValueArg, or UnlabeledMultiArg instead.

Parameters:

	flag	- The flag identifying the argument.
	name	- The name identifying the argument.
	desc	- The description of the argument, used in the usage.
	req	- Whether the argument is required.
	valreq	- Whether the a value is required for the argument.
	v	- The visitor checked by the argument. Defaults to NULL.

TCLAP::Arg::~Arg

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

void TCLAP::Arg::_checkWithVisitor

(

)

const [inline, protected]

Performs the special handling described by the Vistitor.

bool TCLAP::Arg::_hasBlanks

(

const std::string &

s

)

const [inline]

Implementation of _hasBlanks.

If so, return true, otherwise return false.

Parameters:

s

- string to be checked.

void TCLAP::Arg::addToList

(

std::list< Arg * > &

argList

)

const [inline, virtual]

Overridden by Args that need to added to the end of the list.

Parameters:

argList

- The list to add this to.

Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.

bool TCLAP::Arg::argMatches

(

const std::string &

s

)

const [inline, virtual]

A method that tests whether a string matches this argument.

This is generally called by the processArg() method. This method could be re-implemented by a child to change how arguments are specified on the command line.

Parameters:

s

- The string to be compared to the flag/name to determine whether the arg matches.

static void TCLAP::Arg::beginIgnoring

(

)

[inline, static]

Begin ignoring arguments since the "--" argument was specified.

static const char TCLAP::Arg::blankChar

(

)

[inline, static]

The char used as a place holder when SwitchArgs are combined.

Currently set to '*', which shouldn't cause many problems since *'s are expanded by most shells on the command line.

static char TCLAP::Arg::delimiter

(

)

[inline, static]

The delimiter that separates an argument flag/name from the value.

static char& TCLAP::Arg::delimiterRef

(

)

[inline, static, private]

The delimiter that separates an argument flag/name from the value.

static const char TCLAP::Arg::flagStartChar

(

)

[inline, static]

The char that indicates the beginning of a flag.

Currently '-'.

static const std::string TCLAP::Arg::flagStartString

(

)

[inline, static]

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

void TCLAP::Arg::forceRequired

(

)

[inline]

Sets _required to true.

This is used by the XorHandler. You really have no reason to ever use it.

std::string TCLAP::Arg::getDescription

(

)

const [inline]

Returns the argument description.

const std::string & TCLAP::Arg::getFlag

(

)

const [inline]

Returns the argument flag.

const std::string & TCLAP::Arg::getName

(

)

const [inline]

Returns the argument name.

static const std::string TCLAP::Arg::ignoreNameString

(

)

[inline, static]

The name used to identify the ignore rest argument.

static bool TCLAP::Arg::ignoreRest

(

)

[inline, static]

Whether to ignore the rest.

static bool& TCLAP::Arg::ignoreRestRef

(

)

[inline, static, private]

Indicates whether the rest of the arguments should be ignored.

bool TCLAP::Arg::isIgnoreable

(

)

const [inline]

Indicates whether the argument can be ignored, if desired.

bool TCLAP::Arg::isRequired

(

)

const [inline, virtual]

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

bool TCLAP::Arg::isSet

(

)

const [inline]

Indicates whether the argument has already been set.

Only true if the arg has been matched on the command line.

bool TCLAP::Arg::isValueRequired

(

)

const [inline]

Indicates whether a value must be specified for argument.

std::string TCLAP::Arg::longID

(

const std::string &

valueId = "val"

)

const [inline, virtual]

Returns a long ID for the usage.

Parameters:

valueId

- The value used in the id.

Reimplemented in TCLAP::MultiArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

static const std::string TCLAP::Arg::nameStartString

(

)

[inline, static]

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

bool TCLAP::Arg::operator==

(

const Arg &

a

)

[inline, virtual]

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters:

a

- The Arg to be compared to this.

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

Pure virtual method meant to handle the parsing and value assignment of the string on the command line.

Parameters:

	i	- Pointer the the current argument in the list.
	args	- Mutable list of strings. What is passed in from main.

Implemented in TCLAP::MultiArg< T >, TCLAP::SwitchArg, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

static void TCLAP::Arg::setDelimiter

(

char

c

)

[inline, static]

Sets the delimiter for all arguments.

Parameters:

c

- The character that delimits flags/names from values.

void TCLAP::Arg::setRequireLabel

(

const std::string &

s

)

[inline]

Sets the requireLabel.

Used by XorHandler. You shouldn't ever use this.

Parameters:

s

- Set the requireLabel to this value.

std::string TCLAP::Arg::shortID

(

const std::string &

valueId = "val"

)

const [inline, virtual]

Returns a short ID for the usage.

Parameters:

valueId

- The value used in the id.

Reimplemented in TCLAP::MultiArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::UnlabeledValueArg< T >, and TCLAP::ValueArg< T >.

std::string TCLAP::Arg::toString

(

)

const [inline, virtual]

Returns a simple string representation of the argument.

Primarily for debugging.

void TCLAP::Arg::trimFlag	(	std::string &	flag,
		std::string &	value
	)			const [inline, virtual]

Implementation of trimFlag.

Parameters:

	flag	- The string from which the flag and value will be trimmed. Contains the flag once the value has been trimmed.
	value	- Where the value trimmed from the string will be stored.

void TCLAP::Arg::xorSet

(

)

[inline]

Sets the _alreadySet value to true.

This is used by the XorHandler. You really have no reason to ever use it.

---

Member Data Documentation

bool TCLAP::Arg::_alreadySet [protected]

Indicates whether the argument has been set.

Indicates that a value on the command line has matched the name/flag of this argument and the values have been set accordingly.

std::string TCLAP::Arg::_description [protected]

Description of the argument.

std::string TCLAP::Arg::_flag [protected]

The single char flag used to identify the argument.

This value (preceded by a dash {-}), can be used to identify an argument on the command line. The _flag can be blank, in fact this is how unlabeled args work. Unlabeled args must override appropriate functions to get correct handling. Note that the _flag does NOT include the dash as part of the flag.

bool TCLAP::Arg::_ignoreable [protected]

Whether this argument can be ignored, if desired.

std::string TCLAP::Arg::_name [protected]

A single work namd indentifying the argument.

This value (preceded by two dashed {--}) can also be used to identify an argument on the command line. Note that the _name does NOT include the two dashes as part of the _name. The _name cannot be blank.

bool TCLAP::Arg::_required [protected]

Indicating whether the argument is required.

std::string TCLAP::Arg::_requireLabel [protected]

Label to be used in usage description.

Normally set to "required", but can be changed when necessary.

bool TCLAP::Arg::_valueRequired [protected]

Indicates whether a value is required for the argument.

Note that the value may be required but the argument/value combination may not be, as specified by _required.

Visitor* TCLAP::Arg::_visitor [protected]

A pointer to a vistitor object.

The visitor allows special handling to occur as soon as the argument is matched. This defaults to NULL and should not be used unless absolutely necessary.

bool TCLAP::Arg::_xorSet [protected]

Indicates that the arg was set as part of an XOR and not on the command line.

---

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

• tclap/Arg.h

---