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>
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 |
( |
| ) |
|
|
inlinevirtual |
virtual void ecl::CmdLineInterface::add |
( |
Arg & |
a | ) |
|
|
pure virtual |
Adds an argument to the list of arguments to be parsed.
- Parameters
-
Implemented in ecl::CmdLine.
virtual void ecl::CmdLineInterface::add |
( |
Arg * |
a | ) |
|
|
pure virtual |
An alternative add. Functionally identical.
- Parameters
-
Implemented in ecl::CmdLine.
virtual std::list<Arg*>& ecl::CmdLineInterface::getArgList |
( |
| ) |
|
|
pure virtual |
virtual char ecl::CmdLineInterface::getDelimiter |
( |
| ) |
|
|
pure virtual |
virtual std::string& ecl::CmdLineInterface::getMessage |
( |
| ) |
|
|
pure virtual |
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 |
virtual XorHandler& ecl::CmdLineInterface::getXorHandler |
( |
| ) |
|
|
pure virtual |
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.
- Parameters
-
argc | - Number of arguments. |
argv | - Array of arguments. |
Implemented in ecl::CmdLine.
virtual void ecl::CmdLineInterface::setOutput |
( |
CmdLineOutput * |
co | ) |
|
|
pure virtual |
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.
- Parameters
-
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.
- Parameters
-
xors | - List of Args to be added and xor'd. |
Implemented in ecl::CmdLine.
The documentation for this class was generated from the following file: