#include <CmdLineInterface.h>
Inheritance diagram for TCLAP::CmdLineInterface:
Public Member Functions | |
virtual | ~CmdLineInterface () |
Destructor. | |
virtual void | add (Arg &a)=0 |
Adds an argument to the list of arguments to be parsed. | |
virtual void | add (Arg *a)=0 |
An alternative add. | |
virtual void | xorAdd (Arg &a, Arg &b)=0 |
Add two Args that will be xor'd. | |
virtual void | xorAdd (std::vector< Arg * > &xors)=0 |
Add a list of Args that will be xor'd. | |
virtual void | parse (int argc, const char *const *argv)=0 |
Parses the command line. | |
void | parse (std::vector< std::string > &args) |
Parses the command line. | |
virtual CmdLineOutput * | getOutput ()=0 |
Returns the CmdLineOutput object. | |
virtual void | setOutput (CmdLineOutput *co)=0 |
virtual std::string & | getVersion ()=0 |
Returns the version string. | |
virtual std::string & | getProgramName ()=0 |
Returns the program name string. | |
virtual std::list< Arg * > & | getArgList ()=0 |
Returns the argList. | |
virtual XorHandler & | getXorHandler ()=0 |
Returns the XorHandler. | |
virtual char | getDelimiter ()=0 |
Returns the delimiter string. | |
virtual std::string & | getMessage ()=0 |
Returns the message string. | |
virtual bool | hasHelpAndVersion ()=0 |
Indicates whether or not the help and version switches were created automatically. | |
virtual void | reset ()=0 |
Resets the instance as if it had just been constructed so that the instance can be reused. |
Definition at line 43 of file CmdLineInterface.h.
|
Destructor.
Definition at line 50 of file CmdLineInterface.h. |
|
An alternative add. Functionally identical.
Implemented in TCLAP::CmdLine. |
|
Adds an argument to the list of arguments to be parsed.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::MultiArg< T >::MultiArg(), TCLAP::MultiSwitchArg::MultiSwitchArg(), TCLAP::SwitchArg::SwitchArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg(), and TCLAP::ValueArg< T >::ValueArg(). |
|
Returns the argList.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), TCLAP::ZshCompletionOutput::usage(), and TCLAP::DocBookOutput::usage(). |
|
Returns the delimiter string.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::ZshCompletionOutput::usage(), and TCLAP::DocBookOutput::usage(). |
|
Returns the message string.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::StdOutput::_longUsage(), and TCLAP::DocBookOutput::usage(). |
|
Returns the CmdLineOutput object.
Implemented in TCLAP::CmdLine. |
|
Returns the program name string.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::StdOutput::_shortUsage(), TCLAP::StdOutput::failure(), TCLAP::ZshCompletionOutput::usage(), TCLAP::DocBookOutput::usage(), and TCLAP::StdOutput::version(). |
|
Returns the version string.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::ZshCompletionOutput::usage(), TCLAP::DocBookOutput::usage(), TCLAP::ZshCompletionOutput::version(), TCLAP::StdOutput::version(), and TCLAP::DocBookOutput::version(). |
|
Returns the XorHandler.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), TCLAP::ZshCompletionOutput::getMutexList(), and TCLAP::DocBookOutput::usage(). |
|
Indicates whether or not the help and version switches were created automatically.
Implemented in TCLAP::CmdLine. Referenced by TCLAP::StdOutput::failure(). |
|
Parses the command line.
Reimplemented in TCLAP::CmdLine. |
|
Parses the command line.
Implemented in TCLAP::CmdLine. |
|
Resets the instance as if it had just been constructed so that the instance can be reused.
Implemented in TCLAP::CmdLine. |
|
Implemented in TCLAP::CmdLine. |
|
Add a list of Args that will be xor'd. If this method is used, add does not need to be called.
Implemented in TCLAP::CmdLine. |
|
Add two Args that will be xor'd. If this method is used, add does not need to be called.
Implemented in TCLAP::CmdLine. |