Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
TCLAP::CmdLine 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 63 of file CmdLine.h.

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

Inheritance diagram for TCLAP::CmdLine:
Inheritance graph

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.
 
CmdLineOutputgetOutput ()
 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.
 
XorHandlergetXorHandler ()
 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.
 

Constructor & Destructor Documentation

◆ CmdLine()

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 272 of file CmdLine.h.

References _constructor().

◆ ~CmdLine()

TCLAP::CmdLine::~CmdLine ( )
inlinevirtual

Deletes any resources allocated by a CmdLine object.

Definition at line 287 of file CmdLine.h.

References _argDeleteOnExitList, _output, _userSetOutput, and _visitorDeleteOnExitList.

Member Function Documentation

◆ _constructor()

void TCLAP::CmdLine::_constructor ( )
inlineprivate

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

Definition at line 306 of file CmdLine.h.

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

Referenced by CmdLine().

◆ _emptyCombined()

bool TCLAP::CmdLine::_emptyCombined ( const std::string &  s)
inlineprotected

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 439 of file CmdLine.h.

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

Referenced by parse().

◆ add() [1/2]

void TCLAP::CmdLine::add ( Arg a)
inlinevirtual

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

Parameters
a- Argument to be added.

Implements TCLAP::CmdLineInterface.

Definition at line 364 of file CmdLine.h.

References add().

Referenced by _constructor(), add(), and xorAdd().

◆ add() [2/2]

void TCLAP::CmdLine::add ( Arg a)
inlinevirtual

An alternative add.

Functionally identical.

Parameters
a- Argument to be added.

Implements TCLAP::CmdLineInterface.

Definition at line 369 of file CmdLine.h.

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

◆ deleteOnExit() [1/2]

void TCLAP::CmdLine::deleteOnExit ( Arg ptr)
inlineprotected

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

Definition at line 451 of file CmdLine.h.

References _argDeleteOnExitList.

Referenced by _constructor().

◆ deleteOnExit() [2/2]

void TCLAP::CmdLine::deleteOnExit ( Visitor ptr)
inlineprotected

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

Definition at line 456 of file CmdLine.h.

References _visitorDeleteOnExitList.

◆ getArgList()

std::list< Arg * > & TCLAP::CmdLine::getArgList ( )
inlinevirtual

Returns the argList.

Implements TCLAP::CmdLineInterface.

Definition at line 482 of file CmdLine.h.

References _argList.

◆ getDelimiter()

char TCLAP::CmdLine::getDelimiter ( )
inlinevirtual

Returns the delimiter string.

Implements TCLAP::CmdLineInterface.

Definition at line 492 of file CmdLine.h.

References _delimiter.

◆ getMessage()

std::string & TCLAP::CmdLine::getMessage ( )
inlinevirtual

Returns the message string.

Implements TCLAP::CmdLineInterface.

Definition at line 497 of file CmdLine.h.

References _message.

◆ getOutput()

CmdLineOutput * TCLAP::CmdLine::getOutput ( )
inlinevirtual

Returns the CmdLineOutput object.

Implements TCLAP::CmdLineInterface.

Definition at line 461 of file CmdLine.h.

References _output.

◆ getProgramName()

std::string & TCLAP::CmdLine::getProgramName ( )
inlinevirtual

Returns the program name string.

Implements TCLAP::CmdLineInterface.

Definition at line 477 of file CmdLine.h.

References _progName.

◆ getVersion()

std::string & TCLAP::CmdLine::getVersion ( )
inlinevirtual

Returns the version string.

Implements TCLAP::CmdLineInterface.

Definition at line 472 of file CmdLine.h.

References _version.

◆ getXorHandler()

XorHandler & TCLAP::CmdLine::getXorHandler ( )
inlinevirtual

Returns the XorHandler.

Implements TCLAP::CmdLineInterface.

Definition at line 487 of file CmdLine.h.

References _xorHandler.

◆ hasHelpAndVersion()

bool TCLAP::CmdLine::hasHelpAndVersion ( )
inlinevirtual

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

Implements TCLAP::CmdLineInterface.

Definition at line 502 of file CmdLine.h.

References _helpAndVersion.

◆ parse()

bool TCLAP::CmdLine::parse ( int  argc,
char **  argv 
)
inlinevirtual

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 383 of file CmdLine.h.

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

◆ setOutput()

void TCLAP::CmdLine::setOutput ( CmdLineOutput co)
inlinevirtual
Parameters
co- CmdLineOutput object that we want to use instead.

Implements TCLAP::CmdLineInterface.

Definition at line 466 of file CmdLine.h.

References _output, and _userSetOutput.

◆ xorAdd() [1/2]

void TCLAP::CmdLine::xorAdd ( Arg a,
Arg b 
)
inlinevirtual

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 356 of file CmdLine.h.

References xorAdd().

Referenced by xorAdd().

◆ xorAdd() [2/2]

void TCLAP::CmdLine::xorAdd ( std::vector< Arg * > &  xors)
inlinevirtual

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 343 of file CmdLine.h.

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

Member Data Documentation

◆ _argDeleteOnExitList

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 111 of file CmdLine.h.

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

◆ _argList

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

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

Definition at line 71 of file CmdLine.h.

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

◆ _delimiter

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 99 of file CmdLine.h.

Referenced by _constructor(), and getDelimiter().

◆ _helpAndVersion

bool TCLAP::CmdLine::_helpAndVersion
private

Whether or not to automatically create help and version switches.

Definition at line 160 of file CmdLine.h.

Referenced by _constructor(), and hasHelpAndVersion().

◆ _message

std::string TCLAP::CmdLine::_message
protected

A message used to describe the program.

Used in the usage output.

Definition at line 81 of file CmdLine.h.

Referenced by getMessage().

◆ _numRequired

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 93 of file CmdLine.h.

Referenced by add(), and parse().

◆ _output

CmdLineOutput* TCLAP::CmdLine::_output
protected

Object that handles all output for the CmdLine.

Definition at line 123 of file CmdLine.h.

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

◆ _progName

std::string TCLAP::CmdLine::_progName
protected

The name of the program.

Set to argv[0].

Definition at line 76 of file CmdLine.h.

Referenced by getProgramName(), and parse().

◆ _userSetOutput

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 155 of file CmdLine.h.

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

◆ _version

std::string TCLAP::CmdLine::_version
protected

The version to be displayed with the –version switch.

Definition at line 86 of file CmdLine.h.

Referenced by getVersion().

◆ _visitorDeleteOnExitList

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 118 of file CmdLine.h.

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

◆ _xorHandler

XorHandler TCLAP::CmdLine::_xorHandler
protected

The handler that manages xoring lists of args.

Definition at line 104 of file CmdLine.h.

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




Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Thu Dec 14 16:41:50 UTC 2023