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.
|
|
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.
|
|
| CommandOption (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) |
| CommandOption contructor.
|
|
virtual void | foundOption (CommandOptionParse *cop, const char *value=0) |
| foundOption is called by the CommandOptionParse object during the parsing of the command line options.
|
|
virtual void | foundOption (CommandOptionParse *cop, const char **value, int num) |
| foundOption is called by the CommandOptionParse object during the parsing of the command line options.
|
|
virtual void | parseDone (CommandOptionParse *cop) |
| Once parsing of command line options is complete, this method is called.
|
|
virtual void | performTask (CommandOptionParse *cop) |
| Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform.
|
|
virtual bool | hasValue () |
| For fields with the required flag set, this method is used to determine if the Option has satisfied it's required status.
|
|
|
const char ** | values |
| Array of list of values collected for this option.
|
|
int | numValue |
| Number of values in the values array.
|
|
Public Attributes inherited from ost::CommandOption |
const char * | optionName |
| Long option name, these will be preceded with "--" on the command line.
|
|
const char * | optionLetter |
| option letter, these will be preceded with "-" on the command line.
|
|
const char * | description |
| A short description of the option for Usage messages.
|
|
OptionType | optionType |
| This command option's OptionType.
|
|
bool | required |
| True if this parameter is required.
|
|
CommandOption * | next |
| This next CommandOption in this list of options or nil if no more options exist.
|
|
Derived class of CommandOption for options that have a value associated with them.
Classes CommandOptionRest and CommandOptionArg derive from this class.
◆ CommandOptionWithArg()
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 |
◆ ~CommandOptionWithArg()
virtual ost::CommandOptionWithArg::~CommandOptionWithArg |
( |
| ) |
|
|
virtual |
◆ foundOption() [1/2]
virtual void ost::CommandOptionWithArg::foundOption |
( |
CommandOptionParse * |
cop, |
|
|
const char ** |
value, |
|
|
int |
num |
|
) |
| |
|
virtual |
◆ foundOption() [2/2]
virtual void ost::CommandOptionWithArg::foundOption |
( |
CommandOptionParse * |
cop, |
|
|
const char * |
value = 0 |
|
) |
| |
|
virtual |
◆ hasValue()
virtual bool ost::CommandOptionWithArg::hasValue |
( |
| ) |
|
|
virtual |
◆ numValue
int ost::CommandOptionWithArg::numValue |
◆ values
const char** ost::CommandOptionWithArg::values |
Array of list of values collected for this option.
- Examples
- cmdlineopt.cpp.
The documentation for this class was generated from the following file: