Derived class of CommandOption for options that have a value associated with them.
More...
#include <cmdoptns.h>
|
| 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 Member Functions inherited from ost::CommandOption |
virtual | ~CommandOption () |
| A virtual destructor just in case. More...
|
|
| CommandOption (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) |
| CommandOption contructor. More...
|
|
virtual void | parseDone (CommandOptionParse *cop) |
| Once parsing of command line options is complete, this method is called. More...
|
|
virtual void | performTask (CommandOptionParse *cop) |
| Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform. More...
|
|
Derived class of CommandOption for options that have a value associated with them.
Classes CommandOptionRest and CommandOptionArg derive from this class.
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 |
virtual void ost::CommandOptionWithArg::foundOption |
( |
CommandOptionParse * |
cop, |
|
|
const char * |
value = 0 |
|
) |
| |
|
virtual |
virtual void ost::CommandOptionWithArg::foundOption |
( |
CommandOptionParse * |
cop, |
|
|
const char ** |
value, |
|
|
int |
num |
|
) |
| |
|
virtual |
virtual bool ost::CommandOptionWithArg::hasValue |
( |
| ) |
|
|
virtual |
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: