TCLAP::CmdLineInterface Class Reference

#include <CmdLineInterface.h>

Inheritance diagram for TCLAP::CmdLineInterface:

Public Member Functions
virtual void	add (Arg &a)=0
virtual void	add (Arg *a)=0
virtual std::list< Arg * > &	getArgList ()=0
virtual char	getDelimiter ()=0
virtual std::string &	getMessage ()=0
virtual CmdLineOutput *	getOutput ()=0
virtual std::string &	getProgramName ()=0
virtual std::string &	getVersion ()=0
virtual XorHandler &	getXorHandler ()=0
virtual bool	hasHelpAndVersion ()=0
virtual void	parse (int argc, const char *const *argv)=0
void	parse (std::vector< std::string > &args)
virtual void	reset ()=0
virtual void	setOutput (CmdLineOutput *co)=0
virtual void	xorAdd (Arg &a, Arg &b)=0
virtual void	xorAdd (std::vector< Arg * > &xors)=0
virtual	~CmdLineInterface ()

Detailed Description

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

Definition at line 43 of file CmdLineInterface.h.

Constructor & Destructor Documentation

virtual TCLAP::CmdLineInterface::~CmdLineInterface ( )

inlinevirtual

Destructor

Definition at line 50 of file CmdLineInterface.h.

Member Function Documentation

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.

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

pure virtual

An alternative add. Functionally identical.

Parameters

a	- Argument to be added.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the argList.

Implemented in TCLAP::CmdLine.

virtual char TCLAP::CmdLineInterface::getDelimiter ( )

pure virtual

Returns the delimiter string.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the message string.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the CmdLineOutput object.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the program name string.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the version string.

Implemented in TCLAP::CmdLine.

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

pure virtual

Returns the XorHandler.

Implemented in TCLAP::CmdLine.

virtual bool TCLAP::CmdLineInterface::hasHelpAndVersion ( )

pure virtual

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

Implemented in TCLAP::CmdLine.

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

pure virtual

Parses the command line.

Parameters

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

Implemented in TCLAP::CmdLine.

void TCLAP::CmdLineInterface::parse

(

std::vector< std::string > &

args

)

Parses the command line.

Parameters

args	- A vector of strings representing the args. args[0] is still the program name.

virtual void TCLAP::CmdLineInterface::reset ( )

pure virtual

Resets the instance as if it had just been constructed so that the instance can be reused.

Implemented in TCLAP::CmdLine.

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

pure virtual

Parameters

co	- CmdLineOutput object that we want to use instead.

Implemented in TCLAP::CmdLine.

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.

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.

---

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

• CmdLineInterface.h