TCLAP::MultiArg Class Reference

---

Detailed Description

An argument that allows multiple values of type T to be specified.

Very similar to a ValueArg, except a vector of values will be returned instead of just one.

#include <mrpt/otherlibs/tclap/MultiArg.h>

Inheritance diagram for TCLAP::MultiArg:

List of all members.

Public Member Functions
	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, Constraint< T > *constraint, Visitor *v=NULL)
	Constructor.
	MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL)
	Constructor.
virtual bool	processArg (int *i, std::vector< std::string > &args)
	Handles the processing of the argument.
const std::vector< T > &	getValue ()
	Returns a vector of type T containing the values parsed from the command line.
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	isRequired () const
	Once we've matched the first value, then the arg is no longer required.
virtual bool	allowMore ()
virtual void	addToList (std::list< Arg * > &argList) const
	Adds this to the specified list of Args.
virtual bool	operator== (const Arg &a) const
	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.
virtual bool	acceptsMultipleValues ()
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	_extractValue (const std::string &val)
	Extracts the value from the string.
void	_checkWithVisitor () const
	Performs the special handling described by the Vistitor.
Protected Attributes
std::vector< T >	_values
	The list of values parsed from the CmdLine.
std::string	_typeDesc
	The description of type T to be used in the usage.
Constraint< T > *	_constraint
	A list of constraint on this Arg.
bool	_allowMore
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.
bool	_acceptsMultipleValues

---

Constructor & Destructor Documentation

TCLAP::MultiArg::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		const std::string &	typeDesc,
		Visitor *	v = NULL
	)

Constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
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.
req	- Whether the argument is required 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.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 333 of file MultiArg.h.

References TCLAP::Arg::_acceptsMultipleValues.

TCLAP::MultiArg::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.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
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.
req	- Whether the argument is required 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
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 348 of file MultiArg.h.

References TCLAP::CmdLineInterface::add(), and TCLAP::Arg::_acceptsMultipleValues.

TCLAP::MultiArg::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		Visitor *	v = NULL
	)

Constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
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.
req	- Whether the argument is required on the command line.
constraint	- A pointer to a Constraint object used to constrain this Arg.
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 368 of file MultiArg.h.

References TCLAP::Arg::_acceptsMultipleValues.

TCLAP::MultiArg::MultiArg	(	const std::string &	flag,
		const std::string &	name,
		const std::string &	desc,
		bool	req,
		Constraint< T > *	constraint,
		CmdLineInterface &	parser,
		Visitor *	v = NULL
	)

Constructor.

Parameters:

flag	- The one character flag that identifies this argument on the command line.
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.
req	- Whether the argument is required on the command line.
constraint	- A pointer to a Constraint object used to constrain this Arg.
parser	- A CmdLine parser object to add this Arg to
v	- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 383 of file MultiArg.h.

References TCLAP::CmdLineInterface::add(), and TCLAP::Arg::_acceptsMultipleValues.

---

Member Function Documentation

void TCLAP::Arg::_checkWithVisitor

(

)

const [inline, protected, inherited]

Performs the special handling described by the Vistitor.

Definition at line 511 of file Arg.h.

References TCLAP::Arg::_visitor, and TCLAP::Visitor::visit().

Referenced by TCLAP::MultiSwitchArg::processArg(), and TCLAP::SwitchArg::processArg().

void TCLAP::MultiArg::_extractValue

(

const std::string &

val

)

[protected]

Extracts the value from the string.

Attempts to parse string as type T, if this fails an exception is thrown.

Parameters:

val	- The string to be read.

Definition at line 495 of file MultiArg.h.

References TCLAP::MULTI_ARG_HELPER::ValueExtractor::extractValue(), TCLAP::MULTI_ARG_HELPER::EXTRACT_FAILURE, and TCLAP::MULTI_ARG_HELPER::EXTRACT_TOO_MANY.

bool TCLAP::Arg::_hasBlanks

(

const std::string &

s

)

const [inline, inherited]

Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.

Implementation of _hasBlanks.

If so, return true, otherwise return false.

Parameters:

s	- string to be checked.

Definition at line 541 of file Arg.h.

References TCLAP::Arg::blankChar().

bool TCLAP::Arg::acceptsMultipleValues

(

)

[inline, virtual, inherited]

Definition at line 574 of file Arg.h.

References TCLAP::Arg::_acceptsMultipleValues.

Referenced by TCLAP::DocBookOutput::printShortArg().

void TCLAP::Arg::addToList

(

std::list< Arg * > &

argList

)

const [inline, virtual, inherited]

Adds this to the specified list of Args.

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

Parameters:

argList

- The list to add this to.

Definition at line 564 of file Arg.h.

Referenced by TCLAP::CmdLine::add().

bool TCLAP::MultiArg::allowMore

(

)

[virtual]

Reimplemented from TCLAP::Arg.

Definition at line 518 of file MultiArg.h.

bool TCLAP::Arg::argMatches

(

const std::string &

s

)

const [inline, virtual, inherited]

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 490 of file Arg.h.

References TCLAP::Arg::flagStartString(), TCLAP::Arg::_flag, TCLAP::Arg::nameStartString(), and TCLAP::Arg::_name.

Referenced by TCLAP::MultiSwitchArg::processArg(), and TCLAP::SwitchArg::processArg().

static void TCLAP::Arg::beginIgnoring

(

)

[inline, static, inherited]

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

Definition at line 170 of file Arg.h.

References TCLAP::Arg::ignoreRestRef().

Referenced by TCLAP::IgnoreRestVisitor::visit().

static const char TCLAP::Arg::blankChar

(

)

[inline, static, inherited]

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.

Definition at line 188 of file Arg.h.

Referenced by TCLAP::Arg::_hasBlanks(), TCLAP::CmdLine::_emptyCombined(), and TCLAP::SwitchArg::combinedSwitchesMatch().

static char TCLAP::Arg::delimiter

(

)

[inline, static, inherited]

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

Definition at line 181 of file Arg.h.

References TCLAP::Arg::delimiterRef().

Referenced by TCLAP::Arg::shortID(), and TCLAP::Arg::trimFlag().

static const char TCLAP::Arg::flagStartChar

(

)

[inline, static, inherited]

The char that indicates the beginning of a flag.

Currently '-'.

Definition at line 193 of file Arg.h.

Referenced by TCLAP::CmdLine::_emptyCombined().

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

(

)

[inline, static, inherited]

The sting that indicates the beginning of a flag.

Currently "-". Should be identical to flagStartChar.

Definition at line 199 of file Arg.h.

Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), TCLAP::CmdLine::_constructor(), and TCLAP::SwitchArg::combinedSwitchesMatch().

void TCLAP::Arg::forceRequired

(

)

[inline, inherited]

Sets _required to true.

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

Definition at line 550 of file Arg.h.

References TCLAP::Arg::_required.

std::string TCLAP::Arg::getDescription

(

)

const [inline, inherited]

Returns the argument description.

Definition at line 454 of file Arg.h.

References TCLAP::Arg::_required, TCLAP::Arg::_requireLabel, and TCLAP::Arg::_description.

Referenced by TCLAP::DocBookOutput::printLongArg(), TCLAP::UnlabeledMultiArg::operator==(), and TCLAP::UnlabeledValueArg::operator==().

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

(

)

const [inline, inherited]

Returns the argument flag.

Definition at line 467 of file Arg.h.

References TCLAP::Arg::_flag.

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

(

)

const [inline, inherited]

Returns the argument name.

Definition at line 469 of file Arg.h.

References TCLAP::Arg::_name.

Referenced by TCLAP::UnlabeledMultiArg::operator==(), and TCLAP::UnlabeledValueArg::operator==().

const std::vector< T > & TCLAP::MultiArg::getValue

(

)

Returns a vector of type T containing the values parsed from the command line.

Definition at line 400 of file MultiArg.h.

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

(

)

[inline, static, inherited]

The name used to identify the ignore rest argument.

Definition at line 210 of file Arg.h.

Referenced by TCLAP::Arg::Arg(), and TCLAP::CmdLine::_constructor().

static bool TCLAP::Arg::ignoreRest

(

)

[inline, static, inherited]

Whether to ignore the rest.

Definition at line 175 of file Arg.h.

References TCLAP::Arg::ignoreRestRef().

Referenced by TCLAP::CmdLine::parse(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::SwitchArg::processArg().

bool TCLAP::Arg::isIgnoreable

(

)

const [inline, inherited]

Indicates whether the argument can be ignored, if desired.

Definition at line 483 of file Arg.h.

References TCLAP::Arg::_ignoreable.

bool TCLAP::MultiArg::isRequired

(

)

const [virtual]

Once we've matched the first value, then the arg is no longer required.

Reimplemented from TCLAP::Arg.

Definition at line 480 of file MultiArg.h.

bool TCLAP::Arg::isSet

(

)

const [inline, inherited]

Indicates whether the argument has already been set.

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

Definition at line 475 of file Arg.h.

References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.

bool TCLAP::Arg::isValueRequired

(

)

const [inline, inherited]

Indicates whether a value must be specified for argument.

Definition at line 473 of file Arg.h.

References TCLAP::Arg::_valueRequired.

std::string TCLAP::MultiArg::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 TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg.

Definition at line 468 of file MultiArg.h.

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

(

)

[inline, static, inherited]

The sting that indicates the beginning of a name.

Currently "--". Should be flagStartChar twice.

Definition at line 205 of file Arg.h.

Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), and TCLAP::SwitchArg::combinedSwitchesMatch().

bool TCLAP::Arg::operator==

(

const Arg &

a

)

const [inline, virtual, inherited]

Operator ==.

Equality operator. Must be virtual to handle unlabeled args.

Parameters:

a	- The Arg to be compared to this.

Definition at line 446 of file Arg.h.

References TCLAP::Arg::_flag, and TCLAP::Arg::_name.

bool TCLAP::MultiArg::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:

i	- Pointer the the current argument in the list.
args	- Mutable list of strings. Passed from main().

Implements TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg.

Definition at line 403 of file MultiArg.h.

static void TCLAP::Arg::setDelimiter

(

char

c

)

[inline, static, inherited]

Sets the delimiter for all arguments.

Parameters:

c	- The character that delimits flags/names from values.

Definition at line 216 of file Arg.h.

References TCLAP::Arg::delimiterRef().

Referenced by TCLAP::CmdLine::_constructor().

void TCLAP::Arg::setRequireLabel

(

const std::string &

s

)

[inline, inherited]

Sets the requireLabel.

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

Parameters:

s	- Set the requireLabel to this value.

Definition at line 485 of file Arg.h.

References TCLAP::Arg::_requireLabel.

std::string TCLAP::MultiArg::shortID

(

const std::string &

val = "val"

)

const [virtual]

Returns the a short id string.

Used in the usage.

Parameters:

val	- value to be used.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledMultiArg.

Definition at line 457 of file MultiArg.h.

std::string TCLAP::Arg::toString

(

)

const [inline, virtual, inherited]

Returns a simple string representation of the argument.

Primarily for debugging.

Definition at line 499 of file Arg.h.

References TCLAP::Arg::_flag, TCLAP::Arg::flagStartString(), TCLAP::Arg::nameStartString(), and TCLAP::Arg::_name.

Referenced by TCLAP::Arg::Arg(), and TCLAP::SwitchArg::processArg().

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

Trims a value off of the flag.

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.

Definition at line 520 of file Arg.h.

References TCLAP::Arg::delimiter().

void TCLAP::Arg::xorSet

(

)

[inline, inherited]

Sets the _alreadySet value to true.

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

Definition at line 555 of file Arg.h.

References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.

---

Member Data Documentation

bool TCLAP::Arg::_acceptsMultipleValues [protected, inherited]

Definition at line 128 of file Arg.h.

Referenced by TCLAP::Arg::acceptsMultipleValues(), and MultiArg().

bool TCLAP::MultiArg::_allowMore [protected]

Definition at line 194 of file MultiArg.h.

bool TCLAP::Arg::_alreadySet [protected, inherited]

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 107 of file Arg.h.

Referenced by TCLAP::Arg::isSet(), TCLAP::Arg::xorSet(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::SwitchArg::processArg().

Constraint<T>* TCLAP::MultiArg::_constraint [protected]

A list of constraint on this Arg.

Definition at line 184 of file MultiArg.h.

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

Description of the argument.

Definition at line 82 of file Arg.h.

Referenced by TCLAP::Arg::getDescription().

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

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 68 of file Arg.h.

Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::getFlag(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), and TCLAP::SwitchArg::combinedSwitchesMatch().

bool TCLAP::Arg::_ignoreable [protected, inherited]

Whether this argument can be ignored, if desired.

Definition at line 120 of file Arg.h.

Referenced by TCLAP::Arg::isIgnoreable(), TCLAP::MultiSwitchArg::processArg(), and TCLAP::SwitchArg::processArg().

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

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 77 of file Arg.h.

Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::getName(), TCLAP::Arg::argMatches(), and TCLAP::Arg::toString().

bool TCLAP::Arg::_required [protected, inherited]

Indicating whether the argument is required.

Definition at line 87 of file Arg.h.

Referenced by TCLAP::Arg::shortID(), TCLAP::Arg::getDescription(), TCLAP::Arg::isRequired(), and TCLAP::Arg::forceRequired().

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

Label to be used in usage description.

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

Definition at line 93 of file Arg.h.

Referenced by TCLAP::Arg::getDescription(), and TCLAP::Arg::setRequireLabel().

std::string TCLAP::MultiArg::_typeDesc [protected]

The description of type T to be used in the usage.

Definition at line 179 of file MultiArg.h.

bool TCLAP::Arg::_valueRequired [protected, inherited]

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 100 of file Arg.h.

Referenced by TCLAP::Arg::shortID(), TCLAP::Arg::longID(), and TCLAP::Arg::isValueRequired().

std::vector<T> TCLAP::MultiArg::_values [protected]

The list of values parsed from the CmdLine.

Definition at line 174 of file MultiArg.h.

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

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 115 of file Arg.h.

Referenced by TCLAP::Arg::_checkWithVisitor().

bool TCLAP::Arg::_xorSet [protected, inherited]

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

Definition at line 126 of file Arg.h.

Referenced by TCLAP::Arg::isSet(), and TCLAP::Arg::xorSet().