ost::CommandOption(3) | Library Functions Manual | ost::CommandOption(3) |
NAME¶
ost::CommandOption - CommandOption is the base class for all command line options.SYNOPSIS¶
#include <cmdoptns.h> Inherited by ost::CommandOptionNoArg, and ost::CommandOptionWithArg.Public Types¶
enum OptionType { hasArg, noArg, trailing, collect }
Public Member Functions¶
virtual ~CommandOption ()
Public Attributes¶
const char * optionName
Detailed Description¶
CommandOption is the base class for all command line options.Gianni Mariani gianni@mariani.ws
cmdlineopt.cpp.
Member Enumeration Documentation¶
enum ost::CommandOption::OptionType¶
OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing args. Option type Enumerator:- hasArg
- This option is associated with a value.
- noArg
- This option is a flag only.
- trailing
- Remaining of the command line arguments.
- collect
- Collect values that are not a value to an option.
Constructor & Destructor Documentation¶
virtual ost::CommandOption::~CommandOption () [virtual]¶
A virtual destructor just in case.ost::CommandOption::CommandOption (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionTypeinOptionType, boolinRequired = false, CommandOption **ppNext = & defaultCommandOptionList)¶
CommandOption 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
Member Function Documentation¶
virtual void ost::CommandOption::foundOption (CommandOptionParse *cop, const char *value = 0) [virtual]¶
foundOption is called by the CommandOptionParse object during the parsing of the command line options. Parameters:cop pointer to the command option
parser
value the value of this option
virtual void ost::CommandOption::foundOption (CommandOptionParse *cop, const char **value, intnum) [virtual]¶
foundOption is called by the CommandOptionParse object during the parsing of the command line options. Parameters:cop pointer to the command option
parser
value an array of values of this option
num number of values in the array
virtual bool ost::CommandOption::hasValue () [virtual]¶
For fields with the required flag set, this method is used to determine if the Option has satisfied it's required status. The default methods simply returns true if any values have been found. This could be specialized to return true based on some other criteria. Reimplemented in ost::CommandOptionWithArg.virtual void ost::CommandOption::parseDone (CommandOptionParse *cop) [virtual]¶
Once parsing of command line options is complete, this method is called. This can be used to perform last minute checks on the options collected. Parameters:cop pointer to the command option
parser
virtual void ost::CommandOption::performTask (CommandOptionParse *cop) [virtual]¶
Once CommandOption objects have completed parsing and there are no errors they may have some specific tasks to perform. PerformTask must return. Parameters:cop pointer to the command option
parser
Member Data Documentation¶
const char* ost::CommandOption::description¶
A short description of the option for Usage messages. e.g. Usage: mycommand : blah -f, --file <DESCRIPTION here>CommandOption* ost::CommandOption::next¶
This next CommandOption in this list of options or nil if no more options exist.const char* ost::CommandOption::optionLetter¶
option letter, these will be preceded with '-' on the command line. e.g. -f foo.xconst char* ost::CommandOption::optionName¶
Long option name, these will be preceded with '--' on the command line. e.g. --file foo.xOptionType ost::CommandOption::optionType¶
This command option's OptionType.bool ost::CommandOption::required¶
True if this parameter is required. If the parameter is not supplied and required is true, an error will be flagged in the option processor.Author¶
Generated automatically by Doxygen for GNU CommonC++ from the source code.Sat Jun 23 2012 | GNU CommonC++ |