ost_commandoptionwitharg(3) [debian man page]

ost::CommandOptionWithArg(3)				     Library Functions Manual				      ost::CommandOptionWithArg(3)

NAME

       ost::CommandOptionWithArg -

       Derived class of CommandOption for options that have a value associated with them.

SYNOPSIS

       #include <cmdoptns.h>

       Inherits ost::CommandOption.

       Inherited by ost::CommandOptionArg, ost::CommandOptionCollect, and ost::CommandOptionRest.

   Public Member Functions
       CommandOptionWithArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool
	   inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)
	   CommandOptionWithArg contructor.
       virtual ~CommandOptionWithArg ()
       virtual void foundOption (CommandOptionParse *cop, const char *value=0)
       virtual void foundOption (CommandOptionParse *cop, const char **value, int num)
       virtual bool hasValue ()

   Public Attributes
       const char ** values
	   Array of list of values collected for this option.
       int numValue
	   Number of values in the values array.

   Additional Inherited Members
Detailed Description
       Derived class of CommandOption for options that have a value associated with them.

       Classes CommandOptionRest and CommandOptionArg derive from this class.

Constructor &; Destructor Documentation
   ost::CommandOptionWithArg::CommandOptionWithArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription,
       OptionTypeinOptionType, boolinRequired = false, CommandOption **ppNext = &defaultCommandOptionList)
       CommandOptionWithArg contructor. Note the default values for required and ppNext.

       Parameters:
	   inOptionName long option name
	   inOptionLetter short letter name
	   inDescription short description of the option
	   inOptionType the type of this option
	   inRequired true if option is required
	   ppNext the linked list header

   virtual ost::CommandOptionWithArg::~CommandOptionWithArg () [virtual]
Member Function Documentation
   virtual void ost::CommandOptionWithArg::foundOption (CommandOptionParse *cop, const char *value = 0) [virtual]
       Reimplemented from ost::CommandOption.

   virtual void ost::CommandOptionWithArg::foundOption (CommandOptionParse *cop, const char **value, intnum) [virtual]
       Reimplemented from ost::CommandOption.

   virtual bool ost::CommandOptionWithArg::hasValue () [virtual]
       Reimplemented from ost::CommandOption.

Member Data Documentation
   int ost::CommandOptionWithArg::numValue
       Number of values in the values array.

   const char** ost::CommandOptionWithArg::values
       Array of list of values collected for this option.

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

GNU CommonC++							  Sat Jun 23 2012				      ost::CommandOptionWithArg(3)

Check Out this Related Man Page

ost::CommandOptionParse(3)				     Library Functions Manual					ost::CommandOptionParse(3)

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.

GNU CommonC++							  Sat Jun 23 2012					ost::CommandOptionParse(3)

Linux and UNIX Man Pages

ost_commandoptionwitharg(3) [debian man page]

Check Out this Related Man Page