#include <XorHandler.h>
Public Member Functions | |
XorHandler () | |
Constructor. | |
void | add (std::vector< Arg * > &ors) |
Add a list of Arg*'s that will be orred together. | |
int | check (const Arg *a) |
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. | |
std::string | shortUsage () |
Returns the XOR specific short usage. | |
void | printLongUsage (std::ostream &os) |
Prints the XOR specific long usage. | |
bool | contains (const Arg *a) |
Simply checks whether the Arg is contained in one of the arg lists. | |
std::vector< std::vector< Arg * > > & | getXorList () |
Protected Attributes | |
std::vector< std::vector< Arg * > > | _orList |
The list of of lists of Arg's to be or'd together. |
This is used by CmdLine and you shouldn't ever use it.
Definition at line 38 of file XorHandler.h.
TCLAP::XorHandler::XorHandler | ( | ) | [inline] |
void TCLAP::XorHandler::add | ( | std::vector< Arg * > & | ors | ) | [inline] |
Add a list of Arg*'s that will be orred together.
ors | - list of Arg* that will be xor'd. |
Definition at line 95 of file XorHandler.h.
References _orList.
Referenced by TCLAP::CmdLine::xorAdd().
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.
a | - The Arg to be checked. |
Definition at line 100 of file XorHandler.h.
References _orList, and TCLAP::Arg::isRequired().
Referenced by TCLAP::CmdLine::parse().
std::string TCLAP::XorHandler::shortUsage | ( | ) |
Returns the XOR specific short usage.
void TCLAP::XorHandler::printLongUsage | ( | std::ostream & | os | ) |
Prints the XOR specific long usage.
os | - Stream to print to. |
bool TCLAP::XorHandler::contains | ( | const Arg * | a | ) | [inline] |
Simply checks whether the Arg is contained in one of the arg lists.
a | - The Arg to be checked. |
Definition at line 131 of file XorHandler.h.
References _orList.
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().
std::vector< std::vector< Arg * > > & TCLAP::XorHandler::getXorList | ( | ) | [inline] |
Definition at line 143 of file XorHandler.h.
References _orList.
Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().
std::vector< std::vector<Arg*> > TCLAP::XorHandler::_orList [protected] |
The list of of lists of Arg's to be or'd together.
Definition at line 45 of file XorHandler.h.
Referenced by add(), check(), contains(), and getXorList().