tclap
1.2.0
|
A multiple switch argument. More...
#include <MultiSwitchArg.h>
Public Member Functions | |
MultiSwitchArg (const std::string &flag, const std::string &name, const std::string &desc, int init=0, Visitor *v=NULL) | |
MultiSwitchArg constructor. | |
MultiSwitchArg (const std::string &flag, const std::string &name, const std::string &desc, CmdLineInterface &parser, int init=0, Visitor *v=NULL) | |
MultiSwitchArg constructor. | |
virtual bool | processArg (int *i, std::vector< std::string > &args) |
Handles the processing of the argument. | |
int | getValue () |
Returns int, the number of times the switch has been set. | |
std::string | shortID (const std::string &val) const |
Returns the shortID for this Arg. | |
std::string | longID (const std::string &val) const |
Returns the longID for this Arg. | |
void | reset () |
Clears the Arg object and allows it to be reused by new command lines. | |
Protected Attributes | |
int | _value |
The value of the switch. | |
int | _default |
Used to support the reset() method so that ValueArg can be reset to their constructed value. |
A multiple switch argument.
If the switch is set on the command line, then the getValue method will return the number of times the switch appears.
TCLAP::MultiSwitchArg::MultiSwitchArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
int | init = 0 , |
||
Visitor * | v = NULL |
||
) | [inline] |
MultiSwitchArg constructor.
flag | - The one character flag that identifies this argument on the command line. |
name | - A one word name for the argument. Can be used as a long flag on the command line. |
desc | - A description of what the argument is for or does. |
init | - Optional. The initial/default value of this Arg. Defaults to 0. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 130 of file MultiSwitchArg.h.
TCLAP::MultiSwitchArg::MultiSwitchArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
CmdLineInterface & | parser, | ||
int | init = 0 , |
||
Visitor * | v = NULL |
||
) | [inline] |
MultiSwitchArg constructor.
flag | - The one character flag that identifies this argument on the command line. |
name | - A one word name for the argument. Can be used as a long flag on the command line. |
desc | - A description of what the argument is for or does. |
parser | - A CmdLine parser object to add this Arg to |
init | - Optional. The initial/default value of this Arg. Defaults to 0. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 140 of file MultiSwitchArg.h.
References TCLAP::CmdLineInterface::add().
int TCLAP::MultiSwitchArg::getValue | ( | ) | [inline] |
Returns int, the number of times the switch has been set.
Reimplemented from TCLAP::SwitchArg.
Definition at line 153 of file MultiSwitchArg.h.
References _value.
std::string TCLAP::MultiSwitchArg::longID | ( | const std::string & | val | ) | const [inline, virtual] |
Returns the longID for this Arg.
Reimplemented from TCLAP::Arg.
Definition at line 199 of file MultiSwitchArg.h.
bool TCLAP::MultiSwitchArg::processArg | ( | int * | i, |
std::vector< std::string > & | args | ||
) | [inline, virtual] |
Handles the processing of the argument.
This re-implements the SwitchArg version of this method to set the _value of the argument appropriately.
i | - Pointer the the current argument in the list. |
args | - Mutable list of strings. Passed in from main(). |
Reimplemented from TCLAP::SwitchArg.
Definition at line 155 of file MultiSwitchArg.h.
References TCLAP::Arg::_ignoreable, TCLAP::Arg::ignoreRest(), TCLAP::Arg::argMatches(), TCLAP::Arg::_alreadySet, _value, TCLAP::Arg::_checkWithVisitor(), and TCLAP::SwitchArg::combinedSwitchesMatch().
void TCLAP::MultiSwitchArg::reset | ( | ) | [inline, virtual] |
Clears the Arg object and allows it to be reused by new command lines.
Reimplemented from TCLAP::SwitchArg.
Definition at line 205 of file MultiSwitchArg.h.
std::string TCLAP::MultiSwitchArg::shortID | ( | const std::string & | val | ) | const [inline, virtual] |
Returns the shortID for this Arg.
Reimplemented from TCLAP::Arg.
Definition at line 193 of file MultiSwitchArg.h.
int TCLAP::MultiSwitchArg::_default [protected] |
Used to support the reset() method so that ValueArg can be reset to their constructed value.
Reimplemented from TCLAP::SwitchArg.
Definition at line 52 of file MultiSwitchArg.h.
Referenced by reset().
int TCLAP::MultiSwitchArg::_value [protected] |
The value of the switch.
Reimplemented from TCLAP::SwitchArg.
Definition at line 46 of file MultiSwitchArg.h.
Referenced by getValue(), processArg(), and reset().