TCLAP::CmdLineInterface Class Reference

Detailed Description

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

Definition at line 51 of file CmdLineInterface.h.

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

Inheritance diagram for TCLAP::CmdLineInterface:

Public Member Functions
virtual	~CmdLineInterface ()
	Destructor. More...
virtual void	add (Arg &a)=0
	Adds an argument to the list of arguments to be parsed. More...
virtual void	add (Arg *a)=0
	An alternative add. More...
virtual void	xorAdd (Arg &a, Arg &b)=0
	Add two Args that will be xor'd. More...
virtual void	xorAdd (std::vector< Arg * > &xors)=0
	Add a list of Args that will be xor'd. More...
virtual bool	parse (int argc, char **argv)=0
	Parses the command line. More...
virtual CmdLineOutput *	getOutput ()=0
	Returns the CmdLineOutput object. More...
virtual void	setOutput (CmdLineOutput *co)=0
virtual std::string &	getVersion ()=0
	Returns the version string. More...
virtual std::string &	getProgramName ()=0
	Returns the program name string. More...
virtual std::list< Arg * > &	getArgList ()=0
	Returns the argList. More...
virtual XorHandler &	getXorHandler ()=0
	Returns the XorHandler. More...
virtual char	getDelimiter ()=0
	Returns the delimiter string. More...
virtual std::string &	getMessage ()=0
	Returns the message string. More...
virtual bool	hasHelpAndVersion ()=0
	Indicates whether or not the help and version switches were created automatically. More...

Constructor & Destructor Documentation

~CmdLineInterface()

virtual TCLAP::CmdLineInterface::~CmdLineInterface ( )

inlinevirtual

Destructor.

Definition at line 58 of file CmdLineInterface.h.

Member Function Documentation

add() [1/2]

virtual void TCLAP::CmdLineInterface::add ( Arg &  a )

pure virtual

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

Parameters

a	- Argument to be added.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::MultiArg< T >::MultiArg(), TCLAP::MultiSwitchArg< DUMMY >::MultiSwitchArg(), TCLAP::SwitchArg::SwitchArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg(), and TCLAP::ValueArg< T >::ValueArg().

add() [2/2]

virtual void TCLAP::CmdLineInterface::add ( Arg *  a )

pure virtual

An alternative add.

Functionally identical.

Parameters

a	- Argument to be added.

Implemented in TCLAP::CmdLine.

getArgList()

virtual std::list<Arg*>& TCLAP::CmdLineInterface::getArgList ( )

pure virtual

Returns the argList.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().

getDelimiter()

virtual char TCLAP::CmdLineInterface::getDelimiter ( )

pure virtual

Returns the delimiter string.

Implemented in TCLAP::CmdLine.

getMessage()

virtual std::string& TCLAP::CmdLineInterface::getMessage ( )

pure virtual

Returns the message string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), and TCLAP::DocBookOutput::usage().

getOutput()

virtual CmdLineOutput* TCLAP::CmdLineInterface::getOutput ( )

pure virtual

Returns the CmdLineOutput object.

Implemented in TCLAP::CmdLine.

getProgramName()

virtual std::string& TCLAP::CmdLineInterface::getProgramName ( )

pure virtual

Returns the program name string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_shortUsage(), TCLAP::StdOutput::failure(), TCLAP::DocBookOutput::usage(), and TCLAP::StdOutput::version().

getVersion()

virtual std::string& TCLAP::CmdLineInterface::getVersion ( )

pure virtual

Returns the version string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::DocBookOutput::usage(), TCLAP::DocBookOutput::version(), and TCLAP::StdOutput::version().

getXorHandler()

virtual XorHandler& TCLAP::CmdLineInterface::getXorHandler ( )

pure virtual

Returns the XorHandler.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().

hasHelpAndVersion()

virtual bool TCLAP::CmdLineInterface::hasHelpAndVersion ( )

pure virtual

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

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::failure().

parse()

virtual bool TCLAP::CmdLineInterface::parse ( int  argc, char **  argv  )

pure 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...)

Implemented in TCLAP::CmdLine.

setOutput()

virtual void TCLAP::CmdLineInterface::setOutput ( CmdLineOutput *  co )

pure virtual

Parameters

co	- CmdLineOutput object that we want to use instead.

Implemented in TCLAP::CmdLine.

xorAdd() [1/2]

virtual void TCLAP::CmdLineInterface::xorAdd ( Arg &  a, Arg &  b  )

pure 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.

Implemented in TCLAP::CmdLine.

xorAdd() [2/2]

virtual void TCLAP::CmdLineInterface::xorAdd ( std::vector< Arg * > &  xors )

pure 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.

Implemented in TCLAP::CmdLine.