Public Member Functions | List of all members
basis::CmdLine::XorHandler Class Reference

Handles lists of Arg's that are to be XOR'd on the command-line. More...

#include <CmdLine.h>

+ Inheritance diagram for basis::CmdLine::XorHandler:
+ Collaboration diagram for basis::CmdLine::XorHandler:

Public Member Functions

int check (const Arg *a)
 Checks whether the specified Arg is in one of the xor lists. More...
 
 XorHandler ()
 Constructor. More...
 

Detailed Description

Handles lists of Arg's that are to be XOR'd on the command-line.

This subclass of the TCLAP::XorHandler overloads the check() method such that XOR'd arguments where none of the arguments is required are handled correctly. The TCLA::XorHandler and TCLAP::CmdLine implementations imply that all XOR'd arguments are required, i.e., that one of the mutual exclusive arguments need to be specified. The sbia::basis::XorHandler and sbia::basis::CmdLine implementations, on the other side, do not require that any of the XOR'd arguments be given on the command-line if none of the XOR'd arguments is required.

Definition at line 55 of file CmdLine.h.

Constructor & Destructor Documentation

§ XorHandler()

basis::CmdLine::XorHandler::XorHandler ( )
inline

Constructor.

Definition at line 62 of file CmdLine.h.

Member Function Documentation

§ check()

int basis::CmdLine::XorHandler::check ( const Arg a)
inline

Checks whether the specified Arg is in one of the xor lists.

If the argument does match one, this function returns the size of the xor list that the Arg matched if the Arg is required. If the Arg matches, then it also sets the rest of the Arg's in the list.

Parameters
aThe Arg to be checked.

Definition at line 73 of file CmdLine.h.


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