Managing interface for The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...
#include <cmd_line_interface.hpp>
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, char **argv)=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 () |
Managing interface for The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes.
Definition at line 36 of file cmd_line_interface.hpp.
virtual ecl::CmdLineInterface::~CmdLineInterface | ( | ) | [inline, virtual] |
Destructor
Definition at line 43 of file cmd_line_interface.hpp.
virtual void ecl::CmdLineInterface::add | ( | Arg & | a | ) | [pure virtual] |
Adds an argument to the list of arguments to be parsed.
a | - Argument to be added. |
Implemented in ecl::CmdLine.
virtual void ecl::CmdLineInterface::add | ( | Arg * | a | ) | [pure virtual] |
An alternative add. Functionally identical.
a | - Argument to be added. |
Implemented in ecl::CmdLine.
virtual std::list<Arg*>& ecl::CmdLineInterface::getArgList | ( | ) | [pure virtual] |
Returns the argList.
Implemented in ecl::CmdLine.
virtual char ecl::CmdLineInterface::getDelimiter | ( | ) | [pure virtual] |
Returns the delimiter string.
Implemented in ecl::CmdLine.
virtual std::string& ecl::CmdLineInterface::getMessage | ( | ) | [pure virtual] |
Returns the message string.
Implemented in ecl::CmdLine.
virtual CmdLineOutput* ecl::CmdLineInterface::getOutput | ( | ) | [pure virtual] |
Returns the CmdLineOutput object.
Implemented in ecl::CmdLine.
virtual std::string& ecl::CmdLineInterface::getProgramName | ( | ) | [pure virtual] |
Returns the program name string.
Implemented in ecl::CmdLine.
virtual std::string& ecl::CmdLineInterface::getVersion | ( | ) | [pure virtual] |
Returns the version string.
Implemented in ecl::CmdLine.
virtual XorHandler& ecl::CmdLineInterface::getXorHandler | ( | ) | [pure virtual] |
Returns the XorHandler.
Implemented in ecl::CmdLine.
virtual bool ecl::CmdLineInterface::hasHelpAndVersion | ( | ) | [pure virtual] |
Indicates whether or not the help and version switches were created automatically.
Implemented in ecl::CmdLine.
virtual void ecl::CmdLineInterface::parse | ( | int | argc, |
char ** | argv | ||
) | [pure virtual] |
Parses the command line.
argc | - Number of arguments. |
argv | - Array of arguments. |
Implemented in ecl::CmdLine.
virtual void ecl::CmdLineInterface::setOutput | ( | CmdLineOutput * | co | ) | [pure virtual] |
co | - CmdLineOutput object that we want to use instead. |
Implemented in ecl::CmdLine.
virtual void ecl::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.
a | - Argument to be added and xor'd. |
b | - Argument to be added and xor'd. |
Implemented in ecl::CmdLine.
virtual void ecl::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.
xors | - List of Args to be added and xor'd. |
Implemented in ecl::CmdLine.