TCLAP::XorHandler Class Reference

#include <XorHandler.h>

List of all members.

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

---

Detailed Description

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.

---

Constructor & Destructor Documentation

TCLAP::XorHandler::XorHandler

(

)

[inline]

Constructor. Does nothing.

---

Member Function Documentation

void TCLAP::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.

int TCLAP::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.

bool TCLAP::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.

void TCLAP::XorHandler::printLongUsage

(

std::ostream &

os

)

Prints the XOR specific long usage.

Parameters:

os

- Stream to print to.

std::string TCLAP::XorHandler::shortUsage

(

)

Returns the XOR specific short usage.

---

Member Data Documentation

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

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