ost::CommandOptionArg Class Reference

Class for options with an argument e.g. More...

#include <cmdoptns.h>

Inheritance diagram for ost::CommandOptionArg:

Public Member Functions
	CommandOptionArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList)
	CommandOptionArg contructor. More...
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. 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	foundOption (CommandOptionParse *cop, const char *value=0)
	foundOption is called by the CommandOptionParse object during the parsing of the command line options. More...
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. 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...
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. More...

Additional Inherited Members
Public Types inherited from ost::CommandOption
enum	OptionType { hasArg , noArg , trailing , collect }
	OptionType is for denoting what type of option this is, with an arg, without an arg or the trailing args. More...
Public Attributes inherited from ost::CommandOptionWithArg
const char **	values
	Array of list of values collected for this option. More...
int	numValue
	Number of values in the values array. More...
Public Attributes inherited from ost::CommandOption
const char *	optionName
	Long option name, these will be preceded with "--" on the command line. More...
const char *	optionLetter
	option letter, these will be preceded with "-" on the command line. More...
const char *	description
	A short description of the option for Usage messages. More...
OptionType	optionType
	This command option's OptionType. More...
bool	required
	True if this parameter is required. More...
CommandOption *	next
	This next CommandOption in this list of options or nil if no more options exist. More...

Detailed Description

Class for options with an argument e.g.

–option value .

Examples

cmdlineopt.cpp.

Constructor & Destructor Documentation

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:

• cmdoptns.h