TCLAP::CmdLine Class Reference

The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...

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

Inheritance diagram for TCLAP::CmdLine:

[legend]

Collaboration diagram for TCLAP::CmdLine:

[legend]

List of all members.

Public Member Functions
	CmdLine (const std::string &message, const char delimiter= ' ', const std::string &version="none", bool helpAndVersion=true)
	Command line constructor.
virtual	~CmdLine ()
	Deletes any resources allocated by a CmdLine object.
void	add (Arg &a)
	Adds an argument to the list of arguments to be parsed.
void	add (Arg *a)
	An alternative add.
void	xorAdd (Arg &a, Arg &b)
	Add two Args that will be xor'd.
void	xorAdd (std::vector< Arg * > &xors)
	Add a list of Args that will be xor'd.
bool	parse (int argc, char **argv)
	Parses the command line.
CmdLineOutput *	getOutput ()
	Returns the CmdLineOutput object.
void	setOutput (CmdLineOutput *co)
std::string &	getVersion ()
	Returns the version string.
std::string &	getProgramName ()
	Returns the program name string.
std::list< Arg * > &	getArgList ()
	Returns the argList.
XorHandler &	getXorHandler ()
	Returns the XorHandler.
char	getDelimiter ()
	Returns the delimiter string.
std::string &	getMessage ()
	Returns the message string.
bool	hasHelpAndVersion ()
	Indicates whether or not the help and version switches were created automatically.
Protected Member Functions
bool	_emptyCombined (const std::string &s)
	Checks whether a name/flag string matches entirely matches the Arg::blankChar.
void	deleteOnExit (Arg *ptr)
	Perform a delete ptr; operation on ptr when this object is deleted.
void	deleteOnExit (Visitor *ptr)
	Perform a delete ptr; operation on ptr when this object is deleted.
Protected Attributes
std::list< Arg * >	_argList
	The list of arguments that will be tested against the command line.
std::string	_progName
	The name of the program.
std::string	_message
	A message used to describe the program.
std::string	_version
	The version to be displayed with the --version switch.
int	_numRequired
	The number of arguments that are required to be present on the command line.
char	_delimiter
	The character that is used to separate the argument flag/name from the value.
XorHandler	_xorHandler
	The handler that manages xoring lists of args.
std::list< Arg * >	_argDeleteOnExitList
	A list of Args to be explicitly deleted when the destructor is called.
std::list< Visitor * >	_visitorDeleteOnExitList
	A list of Visitors to be explicitly deleted when the destructor is called.
CmdLineOutput *	_output
	Object that handles all output for the CmdLine.
Private Member Functions
void	_constructor ()
	Encapsulates the code common to the constructors (which is all of it).
Private Attributes
bool	_userSetOutput
	Is set to true when a user sets the output object.
bool	_helpAndVersion
	Whether or not to automatically create help and version switches.

---

Detailed Description

The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes.

Definition at line 55 of file CmdLine.h.

---

Constructor & Destructor Documentation

TCLAP::CmdLine::CmdLine	(	const std::string &	message,
		const char	delimiter = ' ',
		const std::string &	version = "none",
		bool	helpAndVersion = true
	)			[inline]

Command line constructor.

Defines how the arguments will be parsed.

Parameters:

	message	- The message to be used in the usage output.
	delimiter	- The character that is used to separate the argument flag/name from the value. Defaults to ' ' (space).
	version	- The version number to be used in the --version switch.
	helpAndVersion	- Whether or not to create the Help and Version switches. Defaults to true.

Definition at line 264 of file CmdLine.h.

References _constructor().

TCLAP::CmdLine::~CmdLine

(

)

[inline, virtual]

Deletes any resources allocated by a CmdLine object.

Definition at line 279 of file CmdLine.h.

References _argDeleteOnExitList, _output, _userSetOutput, and _visitorDeleteOnExitList.

---

Member Function Documentation

void TCLAP::CmdLine::_constructor

(

)

[inline, private]

Encapsulates the code common to the constructors (which is all of it).

Definition at line 298 of file CmdLine.h.

References _delimiter, _helpAndVersion, _output, add(), deleteOnExit(), TCLAP::Arg::flagStartString(), TCLAP::Arg::ignoreNameString(), and TCLAP::Arg::setDelimiter().

Referenced by CmdLine().

bool TCLAP::CmdLine::_emptyCombined

(

const std::string &

s

)

[inline, protected]

Checks whether a name/flag string matches entirely matches the Arg::blankChar.

Used when multiple switches are combined into a single argument.

Parameters:

s

- The message to be used in the usage.

Definition at line 431 of file CmdLine.h.

References TCLAP::Arg::blankChar(), and TCLAP::Arg::flagStartChar().

Referenced by parse().

void TCLAP::CmdLine::add

(

Arg *

a

)

[inline, virtual]

An alternative add.

Functionally identical.

Parameters:

a

- Argument to be added.

Implements TCLAP::CmdLineInterface.

Definition at line 361 of file CmdLine.h.

References _argList, _numRequired, TCLAP::Arg::addToList(), TCLAP::Arg::isRequired(), and TCLAP::Arg::longID().

void TCLAP::CmdLine::add

(

Arg &

a

)

[inline, virtual]

Adds an argument to the list of arguments to be parsed.

Parameters:

a

- Argument to be added.

Implements TCLAP::CmdLineInterface.

Definition at line 356 of file CmdLine.h.

Referenced by _constructor(), and xorAdd().

void TCLAP::CmdLine::deleteOnExit

(

Visitor *

ptr

)

[inline, protected]

Perform a delete ptr; operation on ptr when this object is deleted.

Definition at line 448 of file CmdLine.h.

References _visitorDeleteOnExitList.

void TCLAP::CmdLine::deleteOnExit

(

Arg *

ptr

)

[inline, protected]

Perform a delete ptr; operation on ptr when this object is deleted.

Definition at line 443 of file CmdLine.h.

References _argDeleteOnExitList.

Referenced by _constructor().

std::list< Arg * > & TCLAP::CmdLine::getArgList

(

)

[inline, virtual]

Returns the argList.

Implements TCLAP::CmdLineInterface.

Definition at line 474 of file CmdLine.h.

References _argList.

char TCLAP::CmdLine::getDelimiter

(

)

[inline, virtual]

Returns the delimiter string.

Implements TCLAP::CmdLineInterface.

Definition at line 484 of file CmdLine.h.

References _delimiter.

std::string & TCLAP::CmdLine::getMessage

(

)

[inline, virtual]

Returns the message string.

Implements TCLAP::CmdLineInterface.

Definition at line 489 of file CmdLine.h.

References _message.

CmdLineOutput * TCLAP::CmdLine::getOutput

(

)

[inline, virtual]

Returns the CmdLineOutput object.

Implements TCLAP::CmdLineInterface.

Definition at line 453 of file CmdLine.h.

References _output.

std::string & TCLAP::CmdLine::getProgramName

(

)

[inline, virtual]

Returns the program name string.

Implements TCLAP::CmdLineInterface.

Definition at line 469 of file CmdLine.h.

References _progName.

std::string & TCLAP::CmdLine::getVersion

(

)

[inline, virtual]

Returns the version string.

Implements TCLAP::CmdLineInterface.

Definition at line 464 of file CmdLine.h.

References _version.

XorHandler & TCLAP::CmdLine::getXorHandler

(

)

[inline, virtual]

Returns the XorHandler.

Implements TCLAP::CmdLineInterface.

Definition at line 479 of file CmdLine.h.

References _xorHandler.

bool TCLAP::CmdLine::hasHelpAndVersion

(

)

[inline, virtual]

Indicates whether or not the help and version switches were created automatically.

Implements TCLAP::CmdLineInterface.

Definition at line 494 of file CmdLine.h.

References _helpAndVersion.

bool TCLAP::CmdLine::parse	(	int	argc,
		char **	argv
	)			[inline, virtual]

Parses the command line.

Parameters:

	argc	- Number of arguments.
	argv	- Array of arguments.

Returns:

(Added by JLBC for MRPT): Return false if the program should exit (error in args, it was --help, etc...)

Implements TCLAP::CmdLineInterface.

Definition at line 375 of file CmdLine.h.

References _argList, _emptyCombined(), _numRequired, _output, _progName, _xorHandler, TCLAP::XorHandler::check(), TCLAP::CmdLineOutput::failure(), and TCLAP::Arg::ignoreRest().

void TCLAP::CmdLine::setOutput

(

CmdLineOutput *

co

)

[inline, virtual]

Parameters:

co

- CmdLineOutput object that we want to use instead.

Implements TCLAP::CmdLineInterface.

Definition at line 458 of file CmdLine.h.

References _output, and _userSetOutput.

void TCLAP::CmdLine::xorAdd

(

std::vector< Arg * > &

xors

)

[inline, virtual]

Add a list of Args that will be xor'd.

If this method is used, add does not need to be called.

Parameters:

xors

- List of Args to be added and xor'd.

Implements TCLAP::CmdLineInterface.

Definition at line 335 of file CmdLine.h.

References _xorHandler, add(), and TCLAP::XorHandler::add().

void TCLAP::CmdLine::xorAdd	(	Arg &	a,
		Arg &	b
	)			[inline, virtual]

Add two Args that will be xor'd.

If this method is used, add does not need to be called.

Parameters:

	a	- Argument to be added and xor'd.
	b	- Argument to be added and xor'd.

Implements TCLAP::CmdLineInterface.

Definition at line 348 of file CmdLine.h.

---

Member Data Documentation

std::list<Arg*> TCLAP::CmdLine::_argDeleteOnExitList [protected]

A list of Args to be explicitly deleted when the destructor is called.

At the moment, this only includes the three default Args.

Definition at line 103 of file CmdLine.h.

Referenced by deleteOnExit(), and ~CmdLine().

std::list<Arg*> TCLAP::CmdLine::_argList [protected]

The list of arguments that will be tested against the command line.

Definition at line 63 of file CmdLine.h.

Referenced by add(), getArgList(), and parse().

char TCLAP::CmdLine::_delimiter [protected]

The character that is used to separate the argument flag/name from the value.

Defaults to ' ' (space).

Definition at line 91 of file CmdLine.h.

Referenced by _constructor(), and getDelimiter().

bool TCLAP::CmdLine::_helpAndVersion [private]

Whether or not to automatically create help and version switches.

Definition at line 152 of file CmdLine.h.

Referenced by _constructor(), and hasHelpAndVersion().

std::string TCLAP::CmdLine::_message [protected]

A message used to describe the program.

Used in the usage output.

Definition at line 73 of file CmdLine.h.

Referenced by getMessage().

int TCLAP::CmdLine::_numRequired [protected]

The number of arguments that are required to be present on the command line.

This is set dynamically, based on the Args added to the CmdLine object.

Definition at line 85 of file CmdLine.h.

Referenced by add(), and parse().

CmdLineOutput* TCLAP::CmdLine::_output [protected]

Object that handles all output for the CmdLine.

Definition at line 115 of file CmdLine.h.

Referenced by _constructor(), getOutput(), parse(), setOutput(), and ~CmdLine().

std::string TCLAP::CmdLine::_progName [protected]

The name of the program.

Set to argv[0].

Definition at line 68 of file CmdLine.h.

Referenced by getProgramName(), and parse().

bool TCLAP::CmdLine::_userSetOutput [private]

Is set to true when a user sets the output object.

We use this so that we don't delete objects that are created outside of this lib.

Definition at line 147 of file CmdLine.h.

Referenced by setOutput(), and ~CmdLine().

std::string TCLAP::CmdLine::_version [protected]

The version to be displayed with the --version switch.

Definition at line 78 of file CmdLine.h.

Referenced by getVersion().

std::list<Visitor*> TCLAP::CmdLine::_visitorDeleteOnExitList [protected]

A list of Visitors to be explicitly deleted when the destructor is called.

At the moment, these are the Vistors created for the default Args.

Definition at line 110 of file CmdLine.h.

Referenced by deleteOnExit(), and ~CmdLine().

XorHandler TCLAP::CmdLine::_xorHandler [protected]

The handler that manages xoring lists of args.

Definition at line 96 of file CmdLine.h.

Referenced by getXorHandler(), parse(), and xorAdd().