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.
#include <mrpt/otherlibs/tclap/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. | |
| bool | combinedSwitchesMatch (std::string &combined) |
| Checks a string to see if any of the chars in the string match the flag for this Switch. | |
| virtual void | addToList (std::list< Arg * > &argList) const |
| Adds this to the specified list of Args. | |
| virtual bool | operator== (const Arg &a) const |
| Operator ==. | |
| const std::string & | getFlag () const |
| Returns the argument flag. | |
| const std::string & | getName () const |
| Returns the argument name. | |
| std::string | getDescription () const |
| Returns the argument description. | |
| virtual bool | isRequired () const |
| Indicates whether the argument is required. | |
| void | forceRequired () |
| Sets _required to true. | |
| void | xorSet () |
| Sets the _alreadySet value to true. | |
| bool | isValueRequired () const |
| Indicates whether a value must be specified for argument. | |
| bool | isSet () const |
| Indicates whether the argument has already been set. | |
| bool | isIgnoreable () const |
| Indicates whether the argument can be ignored, if desired. | |
| virtual bool | argMatches (const std::string &s) const |
| A method that tests whether a string matches this argument. | |
| virtual std::string | toString () const |
| Returns a simple string representation of the argument. | |
| virtual void | trimFlag (std::string &flag, std::string &value) const |
| Trims a value off of the flag. | |
| bool | _hasBlanks (const std::string &s) const |
| Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. | |
| void | setRequireLabel (const std::string &s) |
| Sets the requireLabel. | |
| virtual bool | allowMore () |
| virtual bool | acceptsMultipleValues () |
Static Public Member Functions | |
| static void | beginIgnoring () |
| Begin ignoring arguments since the "--" argument was specified. | |
| static bool | ignoreRest () |
| Whether to ignore the rest. | |
| static char | delimiter () |
| The delimiter that separates an argument flag/name from the value. | |
| static const char | blankChar () |
| The char used as a place holder when SwitchArgs are combined. | |
| static const char | flagStartChar () |
| The char that indicates the beginning of a flag. | |
| static const std::string | flagStartString () |
| The sting that indicates the beginning of a flag. | |
| static const std::string | nameStartString () |
| The sting that indicates the beginning of a name. | |
| static const std::string | ignoreNameString () |
| The name used to identify the ignore rest argument. | |
| static void | setDelimiter (char c) |
| Sets the delimiter for all arguments. | |
Protected Member Functions | |
| void | _checkWithVisitor () const |
| Performs the special handling described by the Vistitor. | |
Protected Attributes | |
| int | _value |
| The value of the switch. | |
| std::string | _flag |
| The single char flag used to identify the argument. | |
| std::string | _name |
| A single work namd indentifying the argument. | |
| std::string | _description |
| Description of the argument. | |
| bool | _required |
| Indicating whether the argument is required. | |
| std::string | _requireLabel |
| Label to be used in usage description. | |
| bool | _valueRequired |
| Indicates whether a value is required for the argument. | |
| bool | _alreadySet |
| Indicates whether the argument has been set. | |
| Visitor * | _visitor |
| A pointer to a vistitor object. | |
| bool | _ignoreable |
| Whether this argument can be ignored, if desired. | |
| bool | _xorSet |
| Indicates that the arg was set as part of an XOR and not on the command line. | |
| bool | _acceptsMultipleValues |
| 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 122 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 131 of file MultiSwitchArg.h.
References TCLAP::CmdLineInterface::add().
| void TCLAP::Arg::_checkWithVisitor | ( | ) | const [inline, protected, inherited] |
Performs the special handling described by the Vistitor.
Definition at line 511 of file Arg.h.
References TCLAP::Arg::_visitor, and TCLAP::Visitor::visit().
Referenced by processArg(), and TCLAP::SwitchArg::processArg().
| bool TCLAP::Arg::_hasBlanks | ( | const std::string & | s | ) | const [inline, inherited] |
Checks whether a given string has blank chars, indicating that it is a combined SwitchArg.
Implementation of _hasBlanks.
If so, return true, otherwise return false.
| s | - string to be checked. |
Definition at line 541 of file Arg.h.
References TCLAP::Arg::blankChar().
| bool TCLAP::Arg::acceptsMultipleValues | ( | ) | [inline, virtual, inherited] |
Definition at line 574 of file Arg.h.
References TCLAP::Arg::_acceptsMultipleValues.
Referenced by TCLAP::DocBookOutput::printShortArg().
Adds this to the specified list of Args.
Overridden by Args that need to added to the end of the list.
| argList | - The list to add this to. |
Definition at line 564 of file Arg.h.
Referenced by TCLAP::CmdLine::add().
| bool TCLAP::Arg::allowMore | ( | ) | [inline, virtual, inherited] |
Reimplemented in TCLAP::MultiArg.
| bool TCLAP::Arg::argMatches | ( | const std::string & | s | ) | const [inline, virtual, inherited] |
A method that tests whether a string matches this argument.
This is generally called by the processArg() method. This method could be re-implemented by a child to change how arguments are specified on the command line.
| s | - The string to be compared to the flag/name to determine whether the arg matches. |
Definition at line 490 of file Arg.h.
References TCLAP::Arg::flagStartString(), TCLAP::Arg::_flag, TCLAP::Arg::nameStartString(), and TCLAP::Arg::_name.
Referenced by processArg(), and TCLAP::SwitchArg::processArg().
| static void TCLAP::Arg::beginIgnoring | ( | ) | [inline, static, inherited] |
Begin ignoring arguments since the "--" argument was specified.
Definition at line 170 of file Arg.h.
References TCLAP::Arg::ignoreRestRef().
Referenced by TCLAP::IgnoreRestVisitor::visit().
| static const char TCLAP::Arg::blankChar | ( | ) | [inline, static, inherited] |
The char used as a place holder when SwitchArgs are combined.
Currently set to '*', which shouldn't cause many problems since *'s are expanded by most shells on the command line.
Definition at line 188 of file Arg.h.
Referenced by TCLAP::Arg::_hasBlanks(), TCLAP::CmdLine::_emptyCombined(), and TCLAP::SwitchArg::combinedSwitchesMatch().
| bool TCLAP::SwitchArg::combinedSwitchesMatch | ( | std::string & | combined | ) | [inline, inherited] |
Checks a string to see if any of the chars in the string match the flag for this Switch.
Definition at line 139 of file SwitchArg.h.
References TCLAP::Arg::flagStartString(), TCLAP::Arg::nameStartString(), TCLAP::Arg::_flag, and TCLAP::Arg::blankChar().
Referenced by processArg(), and TCLAP::SwitchArg::processArg().
| static char TCLAP::Arg::delimiter | ( | ) | [inline, static, inherited] |
The delimiter that separates an argument flag/name from the value.
Definition at line 181 of file Arg.h.
References TCLAP::Arg::delimiterRef().
Referenced by TCLAP::Arg::shortID(), and TCLAP::Arg::trimFlag().
| static const char TCLAP::Arg::flagStartChar | ( | ) | [inline, static, inherited] |
The char that indicates the beginning of a flag.
Currently '-'.
Definition at line 193 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined().
| static const std::string TCLAP::Arg::flagStartString | ( | ) | [inline, static, inherited] |
The sting that indicates the beginning of a flag.
Currently "-". Should be identical to flagStartChar.
Definition at line 199 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), TCLAP::CmdLine::_constructor(), and TCLAP::SwitchArg::combinedSwitchesMatch().
| void TCLAP::Arg::forceRequired | ( | ) | [inline, inherited] |
Sets _required to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 550 of file Arg.h.
References TCLAP::Arg::_required.
| std::string TCLAP::Arg::getDescription | ( | ) | const [inline, inherited] |
Returns the argument description.
Definition at line 454 of file Arg.h.
References TCLAP::Arg::_required, TCLAP::Arg::_requireLabel, and TCLAP::Arg::_description.
Referenced by TCLAP::DocBookOutput::printLongArg(), TCLAP::UnlabeledMultiArg::operator==(), and TCLAP::UnlabeledValueArg::operator==().
| const std::string & TCLAP::Arg::getFlag | ( | ) | const [inline, inherited] |
| const std::string & TCLAP::Arg::getName | ( | ) | const [inline, inherited] |
Returns the argument name.
Definition at line 469 of file Arg.h.
References TCLAP::Arg::_name.
Referenced by TCLAP::UnlabeledMultiArg::operator==(), and TCLAP::UnlabeledValueArg::operator==().
| int TCLAP::MultiSwitchArg::getValue | ( | ) | [inline] |
Returns int, the number of times the switch has been set.
Reimplemented from TCLAP::SwitchArg.
Definition at line 143 of file MultiSwitchArg.h.
References _value.
| static const std::string TCLAP::Arg::ignoreNameString | ( | ) | [inline, static, inherited] |
The name used to identify the ignore rest argument.
Definition at line 210 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), and TCLAP::CmdLine::_constructor().
| static bool TCLAP::Arg::ignoreRest | ( | ) | [inline, static, inherited] |
Whether to ignore the rest.
Definition at line 175 of file Arg.h.
References TCLAP::Arg::ignoreRestRef().
Referenced by TCLAP::CmdLine::parse(), processArg(), and TCLAP::SwitchArg::processArg().
| bool TCLAP::Arg::isIgnoreable | ( | ) | const [inline, inherited] |
Indicates whether the argument can be ignored, if desired.
Definition at line 483 of file Arg.h.
References TCLAP::Arg::_ignoreable.
| bool TCLAP::Arg::isRequired | ( | ) | const [inline, virtual, inherited] |
Indicates whether the argument is required.
Reimplemented in TCLAP::MultiArg.
Definition at line 471 of file Arg.h.
References TCLAP::Arg::_required.
Referenced by TCLAP::CmdLine::add(), TCLAP::DocBookOutput::printShortArg(), and TCLAP::XorHandler::check().
| bool TCLAP::Arg::isSet | ( | ) | const [inline, inherited] |
Indicates whether the argument has already been set.
Only true if the arg has been matched on the command line.
Definition at line 475 of file Arg.h.
References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.
| bool TCLAP::Arg::isValueRequired | ( | ) | const [inline, inherited] |
Indicates whether a value must be specified for argument.
Definition at line 473 of file Arg.h.
References TCLAP::Arg::_valueRequired.
| std::string TCLAP::MultiSwitchArg::longID | ( | const std::string & | val | ) | const [virtual] |
Returns the longID for this Arg.
Reimplemented from TCLAP::Arg.
Definition at line 189 of file MultiSwitchArg.h.
| static const std::string TCLAP::Arg::nameStartString | ( | ) | [inline, static, inherited] |
The sting that indicates the beginning of a name.
Currently "--". Should be flagStartChar twice.
Definition at line 205 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), and TCLAP::SwitchArg::combinedSwitchesMatch().
| bool TCLAP::Arg::operator== | ( | const Arg & | a | ) | const [inline, virtual, inherited] |
Operator ==.
Equality operator. Must be virtual to handle unlabeled args.
| a | - The Arg to be compared to this. |
Definition at line 446 of file Arg.h.
References TCLAP::Arg::_flag, and TCLAP::Arg::_name.
| 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 145 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().
| static void TCLAP::Arg::setDelimiter | ( | char | c | ) | [inline, static, inherited] |
Sets the delimiter for all arguments.
| c | - The character that delimits flags/names from values. |
Definition at line 216 of file Arg.h.
References TCLAP::Arg::delimiterRef().
Referenced by TCLAP::CmdLine::_constructor().
| void TCLAP::Arg::setRequireLabel | ( | const std::string & | s | ) | [inline, inherited] |
Sets the requireLabel.
Used by XorHandler. You shouldn't ever use this.
| s | - Set the requireLabel to this value. |
Definition at line 485 of file Arg.h.
References TCLAP::Arg::_requireLabel.
| std::string TCLAP::MultiSwitchArg::shortID | ( | const std::string & | val | ) | const [virtual] |
Returns the shortID for this Arg.
Reimplemented from TCLAP::Arg.
Definition at line 182 of file MultiSwitchArg.h.
| std::string TCLAP::Arg::toString | ( | ) | const [inline, virtual, inherited] |
Returns a simple string representation of the argument.
Primarily for debugging.
Definition at line 499 of file Arg.h.
References TCLAP::Arg::_flag, TCLAP::Arg::flagStartString(), TCLAP::Arg::nameStartString(), and TCLAP::Arg::_name.
Referenced by TCLAP::Arg::Arg(), and TCLAP::SwitchArg::processArg().
| void TCLAP::Arg::trimFlag | ( | std::string & | flag, |
| std::string & | value | ||
| ) | const [inline, virtual, inherited] |
Trims a value off of the flag.
Implementation of trimFlag.
| flag | - The string from which the flag and value will be trimmed. Contains the flag once the value has been trimmed. |
| value | - Where the value trimmed from the string will be stored. |
Definition at line 520 of file Arg.h.
References TCLAP::Arg::delimiter().
| void TCLAP::Arg::xorSet | ( | ) | [inline, inherited] |
Sets the _alreadySet value to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 555 of file Arg.h.
References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.
bool TCLAP::Arg::_acceptsMultipleValues [protected, inherited] |
Definition at line 128 of file Arg.h.
Referenced by TCLAP::Arg::acceptsMultipleValues(), and TCLAP::MultiArg::MultiArg().
bool TCLAP::Arg::_alreadySet [protected, inherited] |
Indicates whether the argument has been set.
Indicates that a value on the command line has matched the name/flag of this argument and the values have been set accordingly.
Definition at line 107 of file Arg.h.
Referenced by TCLAP::Arg::isSet(), TCLAP::Arg::xorSet(), processArg(), and TCLAP::SwitchArg::processArg().
std::string TCLAP::Arg::_description [protected, inherited] |
Description of the argument.
Definition at line 82 of file Arg.h.
Referenced by TCLAP::Arg::getDescription().
std::string TCLAP::Arg::_flag [protected, inherited] |
The single char flag used to identify the argument.
This value (preceded by a dash {-}), can be used to identify an argument on the command line. The _flag can be blank, in fact this is how unlabeled args work. Unlabeled args must override appropriate functions to get correct handling. Note that the _flag does NOT include the dash as part of the flag.
Definition at line 68 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::getFlag(), TCLAP::Arg::argMatches(), TCLAP::Arg::toString(), and TCLAP::SwitchArg::combinedSwitchesMatch().
bool TCLAP::Arg::_ignoreable [protected, inherited] |
Whether this argument can be ignored, if desired.
Definition at line 120 of file Arg.h.
Referenced by TCLAP::Arg::isIgnoreable(), processArg(), and TCLAP::SwitchArg::processArg().
std::string TCLAP::Arg::_name [protected, inherited] |
A single work namd indentifying the argument.
This value (preceded by two dashed {--}) can also be used to identify an argument on the command line. Note that the _name does NOT include the two dashes as part of the _name. The _name cannot be blank.
Definition at line 77 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::shortID(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::getName(), TCLAP::Arg::argMatches(), and TCLAP::Arg::toString().
bool TCLAP::Arg::_required [protected, inherited] |
Indicating whether the argument is required.
Definition at line 87 of file Arg.h.
Referenced by TCLAP::Arg::shortID(), TCLAP::Arg::getDescription(), TCLAP::Arg::isRequired(), and TCLAP::Arg::forceRequired().
std::string TCLAP::Arg::_requireLabel [protected, inherited] |
Label to be used in usage description.
Normally set to "required", but can be changed when necessary.
Definition at line 93 of file Arg.h.
Referenced by TCLAP::Arg::getDescription(), and TCLAP::Arg::setRequireLabel().
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(), and processArg().
bool TCLAP::Arg::_valueRequired [protected, inherited] |
Indicates whether a value is required for the argument.
Note that the value may be required but the argument/value combination may not be, as specified by _required.
Definition at line 100 of file Arg.h.
Referenced by TCLAP::Arg::shortID(), TCLAP::Arg::longID(), and TCLAP::Arg::isValueRequired().
Visitor* TCLAP::Arg::_visitor [protected, inherited] |
A pointer to a vistitor object.
The visitor allows special handling to occur as soon as the argument is matched. This defaults to NULL and should not be used unless absolutely necessary.
Definition at line 115 of file Arg.h.
Referenced by TCLAP::Arg::_checkWithVisitor().
bool TCLAP::Arg::_xorSet [protected, inherited] |
Indicates that the arg was set as part of an XOR and not on the command line.
Definition at line 126 of file Arg.h.
Referenced by TCLAP::Arg::isSet(), and TCLAP::Arg::xorSet().
| Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011 |