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.

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

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, int num) [virtual] Reimplemented from ost::CommandOption.

virtual bool ost::CommandOptionWithArg::hasValue () [virtual]

Reimplemented from ost::CommandOption.

Member Data Documentation

const char** ost::CommandOptionWithArg::values

Array of list of values collected for this option.

Examples:

cmdlineopt.cpp.

int ost::CommandOptionWithArg::numValue

Number of values in the values array.

Examples:

cmdlineopt.cpp.

Author

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

GNU CommonC++ 25 Aug 2008 ost::CommandOptionWithArg(3)