#include <switch_arg.hpp>
Public Member Functions | |
bool | combinedSwitchesMatch (std::string &combined) |
bool | getValue () |
virtual bool | processArg (int *i, std::vector< std::string > &args) |
SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, bool def=false, Visitor *v=NULL) | |
SwitchArg (const std::string &flag, const std::string &name, const std::string &desc, CmdLineInterface &parser, bool def=false, Visitor *v=NULL) | |
Public Member Functions inherited from ecl::Arg | |
bool | _hasBlanks (const std::string &s) const |
virtual bool | acceptsMultipleValues () |
virtual void | addToList (std::list< Arg * > &argList) const |
virtual bool | allowMore () |
virtual bool | argMatches (const std::string &s) const |
void | forceRequired () |
std::string | getDescription () const |
const std::string & | getFlag () const |
const std::string & | getName () const |
bool | isIgnoreable () const |
virtual bool | isRequired () const |
bool | isSet () const |
bool | isValueRequired () const |
virtual std::string | longID (const std::string &valueId="val") const |
virtual bool | operator== (const Arg &a) const |
void | setRequireLabel (const std::string &s) |
virtual std::string | shortID (const std::string &valueId="val") const |
virtual std::string | toString () const |
virtual void | trimFlag (std::string &flag, std::string &value) const |
void | xorSet () |
virtual | ~Arg () |
Protected Attributes | |
bool | _value |
Protected Attributes inherited from ecl::Arg | |
bool | _acceptsMultipleValues |
bool | _alreadySet |
std::string | _description |
std::string | _flag |
bool | _ignoreable |
std::string | _name |
bool | _required |
std::string | _requireLabel |
bool | _valueRequired |
Visitor * | _visitor |
bool | _xorSet |
Additional Inherited Members | |
Static Public Member Functions inherited from ecl::Arg | |
static void | beginIgnoring () |
static char | blankChar () |
static char | delimiter () |
static char | flagStartChar () |
static std::string | flagStartString () |
static std::string | ignoreNameString () |
static bool | ignoreRest () |
static std::string | nameStartString () |
static void | setDelimiter (char c) |
Protected Member Functions inherited from ecl::Arg | |
void | _checkWithVisitor () const |
Arg (const std::string &flag, const std::string &name, const std::string &desc, bool req, bool valreq, Visitor *v=NULL) | |
A simple switch argument. If the switch is set on the command line, then the getValue method will return the opposite of the default value for the switch.
Definition at line 31 of file switch_arg.hpp.
|
inline |
SwitchArg 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. |
def | - The default value for this Switch. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 108 of file switch_arg.hpp.
|
inline |
SwitchArg 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 |
def | - The default value for this Switch. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 117 of file switch_arg.hpp.
|
inline |
Checks a string to see if any of the chars in the string match the flag for this Switch.
Definition at line 131 of file switch_arg.hpp.
|
inline |
Returns bool, whether or not the switch has been set.
Definition at line 129 of file switch_arg.hpp.
|
inlinevirtual |
Handles the processing of the argument. This re-implements the Arg 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(). |
Implements ecl::Arg.
Reimplemented in ecl::MultiSwitchArg.
Definition at line 160 of file switch_arg.hpp.
|
protected |
The value of the switch.
Definition at line 38 of file switch_arg.hpp.