ecl::XorHandler Class Reference

TClap class indirectly used by CmdLine for handling xor'd arguments. More...

#include <xor_handler.hpp>

List of all members.

Public Member Functions
void	add (std::vector< Arg * > &ors)
int	check (const Arg *a)
bool	contains (const Arg *a)
std::vector< std::vector< Arg * > > &	getXorList ()
void	printLongUsage (std::ostream &os)
std::string	shortUsage ()
	XorHandler ()
Protected Attributes
std::vector< std::vector< Arg * > >	_orList

---

Detailed Description

TClap class indirectly used by CmdLine for handling xor'd arguments.

This class handles lists of Arg's that are to be XOR'd on the command line. This is used by CmdLine and you shouldn't ever use it.

Definition at line 32 of file xor_handler.hpp.

---

Constructor & Destructor Documentation

ecl::XorHandler::XorHandler

(

)

[inline]

Constructor. Does nothing.

Definition at line 46 of file xor_handler.hpp.

---

Member Function Documentation

void ecl::XorHandler::add

(

std::vector< Arg * > &

ors

)

[inline]

Add a list of Arg*'s that will be orred together.

Parameters:

ors	- list of Arg* that will be xor'd.

Definition at line 89 of file xor_handler.hpp.

int ecl::XorHandler::check

(

const Arg *

a

)

[inline]

Checks whether the specified Arg is in one of the xor lists and if it does match one, returns the size of the xor list that the Arg matched. If the Arg matches, then it also sets the rest of the Arg's in the list. You shouldn't use this.

Parameters:

a	- The Arg to be checked.

Definition at line 94 of file xor_handler.hpp.

bool ecl::XorHandler::contains

(

const Arg *

a

)

[inline]

Simply checks whether the Arg is contained in one of the arg lists.

Parameters:

a	- The Arg to be checked.

Definition at line 125 of file xor_handler.hpp.

std::vector< std::vector< Arg * > > & ecl::XorHandler::getXorList

(

)

[inline]

Definition at line 137 of file xor_handler.hpp.

void ecl::XorHandler::printLongUsage

(

std::ostream &

os

)

Prints the XOR specific long usage.

Parameters:

os	- Stream to print to.

std::string ecl::XorHandler::shortUsage

(

)

Returns the XOR specific short usage.

---

Member Data Documentation

std::vector< std::vector<Arg*> > ecl::XorHandler::_orList [protected]

The list of of lists of Arg's to be or'd together.

Definition at line 39 of file xor_handler.hpp.

---

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

• xor_handler.hpp