Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

ost::CommandOptionWithArg Class Reference

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

#include <cmdoptns.h>

Inheritance diagram for ost::CommandOptionWithArg::

ost::CommandOption ost::CommandOptionArg ost::CommandOptionCollect ost::CommandOptionRest List of all members.

Public Methods

 CommandOptionWithArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)
 CommandOptionWithArg contructor. More...

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

int numValue
 Number of values in the values array. More...


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,
OptionType inOptionType,
bool inRequired = 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

ost::CommandOptionWithArg::~CommandOptionWithArg ( ) [virtual]
 


Member Function Documentation

void ost::CommandOptionWithArg::foundOption ( CommandOptionParse * cop,
const char ** value,
int num ) [virtual]
 

Reimplemented from ost::CommandOption.

void ost::CommandOptionWithArg::foundOption ( CommandOptionParse * cop,
const char * value = 0 ) [virtual]
 

Reimplemented from ost::CommandOption.

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.


The documentation for this class was generated from the following file:
Generated at Fri May 30 14:51:02 2008 for GNU CommonC++ by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001