Poster of Linux kernelThe best gift for a Linux geek
ost::CommandOptionParse

ost::CommandOptionParse

Section: C Library Functions (3) Updated: 16 Feb 2010
Local index Up
 

NAME

ost::CommandOptionParse -

This is the CommandOptionParse interface class.

 

SYNOPSIS


#include <cmdoptns.h>  

Public Member Functions


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.  

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.ws>

Examples:

cmdlineopt.cpp.  

Constructor & Destructor Documentation

 

virtual ost::CommandOptionParse::~CommandOptionParse () [pure virtual]

Virtual destructor needed so that the object may be correctly deleted.  

Member Function Documentation

 

virtual bool ost::CommandOptionParse::argsHaveError () [pure virtual]

Get the value of the error flag set if the parser encountered errors.

Examples: cmdlineopt.cpp.  

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.  

virtual const char* ost::CommandOptionParse::printErrors () [pure virtual]

Return a string of text describing the list of errors encountered.

Examples: cmdlineopt.cpp.  

virtual const char* ost::CommandOptionParse::printUsage () [pure virtual]

Return a string that contains the usage description of this list of paramaters.

Examples: cmdlineopt.cpp.  

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.

 

Author

Generated automatically by Doxygen for GNU CommonC++ from the source code.


 

Index

NAME
SYNOPSIS
Public Member Functions
Detailed Description
Constructor & Destructor Documentation
virtual ost::CommandOptionParse::~CommandOptionParse () [pure virtual]
Member Function Documentation
virtual bool ost::CommandOptionParse::argsHaveError () [pure virtual]
virtual void ost::CommandOptionParse::performTask () [pure virtual]
virtual const char* ost::CommandOptionParse::printErrors () [pure virtual]
virtual const char* ost::CommandOptionParse::printUsage () [pure virtual]
virtual void ost::CommandOptionParse::registerError (const char * errMsg) [pure virtual]
Author

This document was created by man2html, using the manual pages.
Time: 21:51:50 GMT, April 16, 2011