TCLAP::Arg Class Reference

#include <Arg.h>

Inheritance diagram for TCLAP::Arg:

List of all members.

Public Member Functions
bool	_hasBlanks (const std::string &s) const
virtual bool	acceptsMultipleValues ()
virtual void	addToList (std::list< Arg * > &argList) const
virtual bool	allowMore ()
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
virtual bool	isRequired () const
bool	isSet () const
bool	isValueRequired () const
virtual std::string	longID (const std::string &valueId="val") const
virtual bool	operator== (const Arg &a) const
virtual bool	processArg (int *i, std::vector< std::string > &args)=0
virtual void	reset ()
void	setRequireLabel (const std::string &s)
virtual std::string	shortID (const std::string &valueId="val") const
virtual std::string	toString () const
virtual void	trimFlag (std::string &flag, std::string &value) const
void	xorSet ()
virtual	~Arg ()
Static Public Member Functions
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
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
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
Private Member Functions
	Arg (const Arg &rhs)
Arg &	operator= (const Arg &rhs)
Static Private Member Functions
static char &	delimiterRef ()
static bool &	ignoreRestRef ()

---

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.

Definition at line 64 of file Arg.h.

---

Constructor & Destructor Documentation

TCLAP::Arg::Arg

(

const Arg &

rhs

)

[private]

Prevent accidental copying.

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.

Definition at line 462 of file Arg.h.

TCLAP::Arg::~Arg

(

)

[inline, virtual]

Destructor.

Definition at line 503 of file Arg.h.

---

Member Function Documentation

void TCLAP::Arg::_checkWithVisitor

(

)

const [inline, protected]

Performs the special handling described by the Vistitor.

Definition at line 611 of file Arg.h.

bool TCLAP::Arg::_hasBlanks

(

const std::string &

s

)

const [inline]

Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. If so, return true, otherwise return false.

Parameters:

s	- string to be checked.

Implementation of _hasBlanks.

Definition at line 641 of file Arg.h.

bool TCLAP::Arg::acceptsMultipleValues

(

)

[inline, virtual]

Use by output classes to determine whether an Arg accepts multiple values.

Definition at line 674 of file Arg.h.

void TCLAP::Arg::addToList

(

std::list< Arg * > &

argList

)

const [inline, virtual]

Adds this to the specified list of Args.

Parameters:

argList

- The list to add this to.

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

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

Definition at line 664 of file Arg.h.

bool TCLAP::Arg::allowMore

(

)

[inline, virtual]

Used for MultiArgs and XorHandler to determine whether args can still be set.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 669 of file Arg.h.

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.

Definition at line 590 of file Arg.h.

static void TCLAP::Arg::beginIgnoring

(

)

[inline, static]

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

Definition at line 200 of file Arg.h.

static char TCLAP::Arg::blankChar

(

)

[inline, static]

The char used as a place holder when SwitchArgs are combined. Currently set to the bell char (ASCII 7).

Definition at line 217 of file Arg.h.

static char TCLAP::Arg::delimiter

(

)

[inline, static]

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

Definition at line 211 of file Arg.h.

static char& TCLAP::Arg::delimiterRef

(

)

[inline, static, private]

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

Definition at line 86 of file Arg.h.

static char TCLAP::Arg::flagStartChar

(

)

[inline, static]

Definition at line 226 of file Arg.h.

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

(

)

[inline, static]

Definition at line 236 of file Arg.h.

void TCLAP::Arg::forceRequired

(

)

[inline]

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

Definition at line 650 of file Arg.h.

std::string TCLAP::Arg::getDescription

(

)

const [inline]

Returns the argument description.

Definition at line 554 of file Arg.h.

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

(

)

const [inline]

Returns the argument flag.

Definition at line 567 of file Arg.h.

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

(

void

)

const [inline]

Returns the argument name.

Definition at line 569 of file Arg.h.

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

(

)

[inline, static]

The name used to identify the ignore rest argument.

Definition at line 250 of file Arg.h.

static bool TCLAP::Arg::ignoreRest

(

)

[inline, static]

Whether to ignore the rest.

Definition at line 205 of file Arg.h.

static bool& TCLAP::Arg::ignoreRestRef

(

)

[inline, static, private]

Indicates whether the rest of the arguments should be ignored.

Definition at line 80 of file Arg.h.

bool TCLAP::Arg::isIgnoreable

(

)

const [inline]

Indicates whether the argument can be ignored, if desired.

Definition at line 583 of file Arg.h.

bool TCLAP::Arg::isRequired

(

)

const [inline, virtual]

Indicates whether the argument is required.

Reimplemented in TCLAP::MultiArg< T >.

Definition at line 571 of file Arg.h.

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.

Definition at line 575 of file Arg.h.

bool TCLAP::Arg::isValueRequired

(

)

const [inline]

Indicates whether a value must be specified for argument.

Definition at line 573 of file Arg.h.

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::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg.

Definition at line 523 of file Arg.h.

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

(

)

[inline, static]

Definition at line 245 of file Arg.h.

Arg& TCLAP::Arg::operator=

(

const Arg &

rhs

)

[private]

Prevent accidental copying.

bool TCLAP::Arg::operator==

(

const Arg &

a

)

const [inline, virtual]

Operator ==. Equality operator. Must be virtual to handle unlabeled args.

Parameters:

a	- The Arg to be compared to this.

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

Definition at line 546 of file Arg.h.

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::ValueArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledMultiArg< T >, TCLAP::MultiSwitchArg, and TCLAP::SwitchArg.

void TCLAP::Arg::reset

(

)

[inline, virtual]

Clears the Arg object and allows it to be reused by new command lines.

Reimplemented in TCLAP::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::MultiSwitchArg, and TCLAP::SwitchArg.

Definition at line 679 of file Arg.h.

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.

Definition at line 256 of file Arg.h.

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.

Definition at line 585 of file Arg.h.

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::ValueArg< T >, TCLAP::MultiArg< T >, TCLAP::UnlabeledValueArg< T >, TCLAP::UnlabeledMultiArg< T >, and TCLAP::MultiSwitchArg.

Definition at line 505 of file Arg.h.

std::string TCLAP::Arg::toString

(

)

const [inline, virtual]

Returns a simple string representation of the argument. Primarily for debugging.

Definition at line 599 of file Arg.h.

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

Trims a value off of the flag.

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.

Implementation of trimFlag.

Definition at line 620 of file Arg.h.

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.

Definition at line 655 of file Arg.h.

---

Member Data Documentation

bool TCLAP::Arg::_acceptsMultipleValues [protected]

Definition at line 158 of file Arg.h.

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.

Definition at line 137 of file Arg.h.

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

Description of the argument.

Definition at line 112 of file Arg.h.

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.

Definition at line 98 of file Arg.h.

bool TCLAP::Arg::_ignoreable [protected]

Whether this argument can be ignored, if desired.

Definition at line 150 of file Arg.h.

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.

Definition at line 107 of file Arg.h.

bool TCLAP::Arg::_required [protected]

Indicating whether the argument is required.

Definition at line 117 of file Arg.h.

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

Label to be used in usage description. Normally set to "required", but can be changed when necessary.

Definition at line 123 of file Arg.h.

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.

Definition at line 130 of file Arg.h.

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.

Definition at line 145 of file Arg.h.

bool TCLAP::Arg::_xorSet [protected]

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

Definition at line 156 of file Arg.h.

---

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

• Arg.h