CommandOptionMutex Class Reference
[Command-Line Options]

#include <CommandOption.hpp>

Inheritance diagram for CommandOptionMutex:

[legend]Collaboration diagram for CommandOptionMutex:

[legend]List of all members.

---

Detailed Description

This is a special "command option" which is really a meta-option to enforce mutual exclusion between a set of real options.

Warning:

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

Definition at line 506 of file CommandOption.hpp.

Public Member Functions
	CommandOptionMutex (const bool required=false)
	CommandOptionMutex contructor.
virtual	~CommandOptionMutex ()
	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.
Protected Attributes
bool	doOneOfChecking

---

Constructor & Destructor Documentation

CommandOptionMutex (  const bool  required = false  )  [inline]

CommandOptionMutex contructor. This sets the CommandOptionType for this object to metaType. Parameters: required  true if option is required. This makes CommandOptionMutex do CommandOptionOneOf-type checking in addition to the exclusion (i.e. it checks to make sure at least one option was specified). Definition at line 518 of file CommandOption.hpp.

virtual ~CommandOptionMutex (   )  [inline, virtual]

Destructor. Definition at line 523 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 232 of file CommandOption.cpp. References CommandOption::getCount(), and CommandOption::getOptionString().

---

Member Data Documentation

bool doOneOfChecking [protected]

Definition at line 528 of file CommandOption.hpp.

---

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

• CommandOption.hpp
• CommandOption.cpp

---