This class handles lists of Arg's that are to be XOR'd on the command line.
More...
#include <XorHandler.h>
|
| | XorHandler () |
| | Constructor. More...
|
| |
| void | add (const std::vector< Arg * > &ors) |
| | Add a list of Arg*'s that will be xor'd together. More...
|
| |
| 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. More...
|
| |
| std::string | shortUsage () |
| | Returns the XOR specific short usage. More...
|
| |
| void | printLongUsage (std::ostream &os) |
| | Prints the XOR specific long usage. More...
|
| |
| bool | contains (const Arg *a) |
| | Simply checks whether the Arg is contained in one of the arg lists. More...
|
| |
| const std::vector< std::vector< Arg * > > & | getXorList () const |
| |
|
| std::vector< std::vector< Arg * > > | _orList |
| | The list of of lists of Arg's to be or'd together. More...
|
| |
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 59 of file XorHandler.h.
◆ XorHandler()
| TCLAP::XorHandler::XorHandler |
( |
| ) |
|
|
inline |
◆ add()
| void TCLAP::XorHandler::add |
( |
const std::vector< Arg * > & |
ors | ) |
|
|
inline |
Add a list of Arg*'s that will be xor'd together.
- Parameters
-
| ors | - list of Arg* that will be xor'd. |
Definition at line 116 of file XorHandler.h.
◆ check()
| 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. |
Definition at line 121 of file XorHandler.h.
Referenced by TCLAP::CmdLine::parse().
◆ contains()
| 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. |
Definition at line 162 of file XorHandler.h.
◆ getXorList()
| const std::vector< std::vector< Arg * > > & TCLAP::XorHandler::getXorList |
( |
| ) |
const |
|
inline |
◆ printLongUsage()
| void TCLAP::XorHandler::printLongUsage |
( |
std::ostream & |
os | ) |
|
Prints the XOR specific long usage.
- Parameters
-
◆ shortUsage()
| std::string TCLAP::XorHandler::shortUsage |
( |
| ) |
|
Returns the XOR specific short usage.
◆ _orList
| std::vector< std::vector<Arg*> > TCLAP::XorHandler::_orList |
|
protected |
The documentation for this class was generated from the following file: