TCLAP::CmdLineInterface Class Reference

#include <CmdLineInterface.h>

Inheritance diagram for TCLAP::CmdLineInterface:
TCLAP::CmdLine

List of all members.

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 CmdLineOutputgetOutput ()=0
virtual std::string & getProgramName ()=0
virtual std::string & getVersion ()=0
virtual XorHandlergetXorHandler ()=0
virtual bool hasHelpAndVersion ()=0
virtual void parse (int argc, char **argv)=0
virtual void setOutput (CmdLineOutput *co)=0
virtual void xorAdd (std::vector< Arg * > &xors)=0
virtual void xorAdd (Arg &a, Arg &b)=0
virtual ~CmdLineInterface ()

Detailed Description

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


Constructor & Destructor Documentation

virtual TCLAP::CmdLineInterface::~CmdLineInterface (  )  [inline, virtual]

Destructor


Member Function Documentation

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 void TCLAP::CmdLineInterface::add ( Arg a  )  [pure virtual]
virtual std::list<Arg*>& TCLAP::CmdLineInterface::getArgList (  )  [pure virtual]
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.

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

virtual CmdLineOutput* TCLAP::CmdLineInterface::getOutput (  )  [pure virtual]

Returns the CmdLineOutput object.

Implemented in TCLAP::CmdLine.

virtual std::string& TCLAP::CmdLineInterface::getProgramName (  )  [pure virtual]
virtual std::string& TCLAP::CmdLineInterface::getVersion (  )  [pure virtual]
virtual XorHandler& TCLAP::CmdLineInterface::getXorHandler (  )  [pure virtual]
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().

virtual void TCLAP::CmdLineInterface::parse ( int  argc,
char **  argv 
) [pure virtual]

Parses the command line.

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

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

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.


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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1