CommandOptionAllOf Class Reference
[Command-Line Options]

#include <CommandOption.hpp>

Inheritance diagram for CommandOptionAllOf:

[legend]Collaboration diagram for CommandOptionAllOf:

[legend]List of all members.

---

Detailed Description

This is a special "command option" which is really a meta-option to make sure that if one of a set of real options has been used, all of the set are used.

Warning:

There's nothing to prevent you from, say, adding another meta-option to the list of mutually exclusive options contained in a CommandOptionAllOf instance (or even itself), but the behavior if you try this is undefined.

Definition at line 474 of file CommandOption.hpp.

Public Member Functions
	CommandOptionAllOf ()
	CommandOptionAllOf contructor.
virtual	~CommandOptionAllOf ()
	Destructor.
virtual std::string	checkArguments ()
	If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match.
virtual unsigned long	getCount () const
	returns the sum of all encapsulated option counts if all are in use, zero otherwise.

---

Constructor & Destructor Documentation

CommandOptionAllOf (   )  [inline]

CommandOptionAllOf contructor. This sets the CommandOptionType for this object to metaType. Definition at line 481 of file CommandOption.hpp.

virtual ~CommandOptionAllOf (   )  [inline, virtual]

Destructor. Definition at line 485 of file CommandOption.hpp.

---

Member Function Documentation

string checkArguments (   )  [virtual]

If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match. If they don't, an error string is returned. If they do, an empty string is returned. Parameters: optVec  complete set of processed command line options being processed (used by some option types). Reimplemented from CommandOptionOneOf. Definition at line 307 of file CommandOption.cpp. References CommandOption::getOptionString().

unsigned long getCount (   )  const [virtual]

returns the sum of all encapsulated option counts if all are in use, zero otherwise. Reimplemented from CommandOption. Definition at line 329 of file CommandOption.cpp. References CommandOption::getCount().

---

The documentation for this class was generated from the following files:

• CommandOption.hpp
• CommandOption.cpp

---