This is the CommandOptionParse interface class.
More...
#include <cmdoptns.h>
|
virtual | ~CommandOptionParse ()=0 |
| Virtual destructor needed so that the object may be correctly deleted. More...
|
|
virtual bool | argsHaveError ()=0 |
| Get the value of the error flag set if the parser encountered errors. More...
|
|
virtual const char * | printErrors ()=0 |
| Return a string of text describing the list of errors encountered. More...
|
|
virtual const char * | printUsage ()=0 |
| Return a string that contains the usage description of this list of paramaters. More...
|
|
virtual void | registerError (const char *errMsg)=0 |
| Register an error with this parser. More...
|
|
virtual void | performTask ()=0 |
| The method should be invoked by the main code once it has determined that the application should be started. More...
|
|
This is the CommandOptionParse interface class.
To implement this object you can call makeCommandOptionParse(); This will instantiate a dynamically allocated version of this class and parse the command line for the list of command options that are passed in.
- Author
- Gianni Mariani giann.nosp@m.i@ma.nosp@m.riani.nosp@m..ws
- Examples:
- cmdlineopt.cpp.
◆ ~CommandOptionParse()
virtual ost::CommandOptionParse::~CommandOptionParse |
( |
| ) |
|
|
pure virtual |
Virtual destructor needed so that the object may be correctly deleted.
◆ argsHaveError()
virtual bool ost::CommandOptionParse::argsHaveError |
( |
| ) |
|
|
pure virtual |
Get the value of the error flag set if the parser encountered errors.
- Examples:
- cmdlineopt.cpp.
◆ performTask()
virtual void ost::CommandOptionParse::performTask |
( |
| ) |
|
|
pure virtual |
The method should be invoked by the main code once it has determined that the application should be started.
- Examples:
- cmdlineopt.cpp.
◆ printErrors()
virtual const char* ost::CommandOptionParse::printErrors |
( |
| ) |
|
|
pure virtual |
Return a string of text describing the list of errors encountered.
- Examples:
- cmdlineopt.cpp.
◆ printUsage()
virtual const char* ost::CommandOptionParse::printUsage |
( |
| ) |
|
|
pure virtual |
Return a string that contains the usage description of this list of paramaters.
- Examples:
- cmdlineopt.cpp.
◆ registerError()
virtual void ost::CommandOptionParse::registerError |
( |
const char * |
errMsg | ) |
|
|
pure virtual |
Register an error with this parser.
This string will be appended to the errors already buffered in this object.
- Examples:
- cmdlineopt.cpp.
The documentation for this class was generated from the following file: