ost::CommandOptionParse - This is the CommandOptionParse interface class.
Contents
Constructor & Destructor Documentation
virtualost::CommandOptionParse::~CommandOptionParse()[purevirtual]
Virtual destructor needed so that the object may be correctly deleted.
Detailed Description
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 gianni@mariani.wsExamplescmdlineopt.cpp.
Member Function Documentation
virtualboolost::CommandOptionParse::argsHaveError()[purevirtual]
Get the value of the error flag set if the parser encountered errors.
Examplescmdlineopt.cpp.
virtualvoidost::CommandOptionParse::performTask()[purevirtual]
The method should be invoked by the main code once it has determined that the application should be
started.
Examplescmdlineopt.cpp.
virtualconstchar*ost::CommandOptionParse::printErrors()[purevirtual]
Return a string of text describing the list of errors encountered.
Examplescmdlineopt.cpp.
virtualconstchar*ost::CommandOptionParse::printUsage()[purevirtual]
Return a string that contains the usage description of this list of paramaters.
Examplescmdlineopt.cpp.
virtualvoidost::CommandOptionParse::registerError(constchar*errMsg)[purevirtual]
Register an error with this parser. This string will be appended to the errors already buffered in this
object.
Examplescmdlineopt.cpp.
Name
ost::CommandOptionParse - This is the CommandOptionParse interface class.
Synopsis
#include <cmdoptns.h>
PublicMemberFunctions
virtual ~CommandOptionParse ()=0
Virtual destructor needed so that the object may be correctly deleted.
virtual bool argsHaveError ()=0
Get the value of the error flag set if the parser encountered errors.
virtual const char * printErrors ()=0
Return a string of text describing the list of errors encountered.
virtual const char * printUsage ()=0
Return a string that contains the usage description of this list of paramaters.
virtual void registerError (const char *errMsg)=0
Register an error with this parser.
virtual void performTask ()=0
The method should be invoked by the main code once it has determined that the application should be
started.
