Class for options with an argument e.g.
More...
#include <cmdoptns.h>
|
| CommandOptionArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) |
| CommandOptionArg contructor.
|
|
virtual | ~CommandOptionArg () |
|
Public Member Functions inherited from ost::CommandOptionWithArg |
| 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.
|
|
Class for options with an argument e.g.
–option value .
- Examples
- cmdlineopt.cpp.
◆ CommandOptionArg()
ost::CommandOptionArg::CommandOptionArg |
( |
const char * |
inOptionName, |
|
|
const char * |
inOptionLetter, |
|
|
const char * |
inDescription, |
|
|
bool |
inRequired = false , |
|
|
CommandOption ** |
ppNext = &defaultCommandOptionList |
|
) |
| |
CommandOptionArg contructor.
This sets the optionType for this object to HasArg.
- Parameters
-
inOptionName | long option name |
inOptionLetter | short letter name |
inDescription | short description of the option |
inRequired | true if option is required |
ppNext | the linked list header |
◆ ~CommandOptionArg()
virtual ost::CommandOptionArg::~CommandOptionArg |
( |
| ) |
|
|
virtual |
The documentation for this class was generated from the following file: