Just like a MultiArg, except that the arguments are unlabeled.
Basically, this Arg will slurp up everything that hasn't been matched to another Arg.
Definition at line 48 of file UnlabeledMultiArg.h.
#include <mrpt/otherlibs/tclap/UnlabeledMultiArg.h>
Public Member Functions | |
UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL) | |
Constructor. More... | |
UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL) | |
Constructor. More... | |
UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, bool ignoreable=false, Visitor *v=NULL) | |
Constructor. More... | |
UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL) | |
Constructor. More... | |
virtual bool | processArg (int *i, std::vector< std::string > &args) |
Handles the processing of the argument. More... | |
virtual std::string | shortID (const std::string &val="val") const |
Returns the a short id string. More... | |
virtual std::string | longID (const std::string &val="val") const |
Returns the a long id string. More... | |
virtual bool | operator== (const Arg &a) const |
Opertor ==. More... | |
virtual void | addToList (std::list< Arg * > &argList) const |
Pushes this to back of list rather than front. More... | |
const std::vector< T > & | getValue () |
Returns a vector of type T containing the values parsed from the command line. More... | |
virtual bool | isRequired () const |
Once we've matched the first value, then the arg is no longer required. More... | |
virtual bool | allowMore () |
const std::string & | getFlag () const |
Returns the argument flag. More... | |
const std::string & | getName () const |
Returns the argument name. More... | |
std::string | getDescription () const |
Returns the argument description. More... | |
void | forceRequired () |
Sets _required to true. More... | |
void | xorSet () |
Sets the _alreadySet value to true. More... | |
bool | isValueRequired () const |
Indicates whether a value must be specified for argument. More... | |
bool | isSet () const |
Indicates whether the argument has already been set. More... | |
bool | isIgnoreable () const |
Indicates whether the argument can be ignored, if desired. More... | |
virtual bool | argMatches (const std::string &s) const |
A method that tests whether a string matches this argument. More... | |
virtual std::string | toString () const |
Returns a simple string representation of the argument. More... | |
virtual void | trimFlag (std::string &flag, std::string &value) const |
Trims a value off of the flag. More... | |
bool | _hasBlanks (const std::string &s) const |
Checks whether a given string has blank chars, indicating that it is a combined SwitchArg. More... | |
void | setRequireLabel (const std::string &s) |
Sets the requireLabel. More... | |
virtual bool | acceptsMultipleValues () |
Static Public Member Functions | |
static void | beginIgnoring () |
Begin ignoring arguments since the "--" argument was specified. More... | |
static bool | ignoreRest () |
Whether to ignore the rest. More... | |
static char | delimiter () |
The delimiter that separates an argument flag/name from the value. More... | |
static char | blankChar () |
The char used as a place holder when SwitchArgs are combined. More... | |
static char | flagStartChar () |
The char that indicates the beginning of a flag. More... | |
static const std::string | flagStartString () |
The sting that indicates the beginning of a flag. More... | |
static const std::string | nameStartString () |
The sting that indicates the beginning of a name. More... | |
static const std::string | ignoreNameString () |
The name used to identify the ignore rest argument. More... | |
static void | setDelimiter (char c) |
Sets the delimiter for all arguments. More... | |
Protected Member Functions | |
void | _extractValue (const std::string &val) |
Extracts the value from the string. More... | |
void | _checkWithVisitor () const |
Performs the special handling described by the Vistitor. More... | |
Protected Attributes | |
std::vector< T > | _values |
The list of values parsed from the CmdLine. More... | |
std::string | _typeDesc |
The description of type T to be used in the usage. More... | |
Constraint< T > * | _constraint |
A list of constraint on this Arg. More... | |
bool | _allowMore |
std::string | _flag |
The single char flag used to identify the argument. More... | |
std::string | _name |
A single work namd indentifying the argument. More... | |
std::string | _description |
Description of the argument. More... | |
bool | _required |
Indicating whether the argument is required. More... | |
std::string | _requireLabel |
Label to be used in usage description. More... | |
bool | _valueRequired |
Indicates whether a value is required for the argument. More... | |
bool | _alreadySet |
Indicates whether the argument has been set. More... | |
Visitor * | _visitor |
A pointer to a vistitor object. More... | |
bool | _ignoreable |
Whether this argument can be ignored, if desired. More... | |
bool | _xorSet |
Indicates that the arg was set as part of an XOR and not on the command line. More... | |
bool | _acceptsMultipleValues |
Static Private Member Functions | |
static bool & | ignoreRestRef () |
Indicates whether the rest of the arguments should be ignored. More... | |
static char & | delimiterRef () |
The delimiter that separates an argument flag/name from the value. More... | |
TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg | ( | const std::string & | name, |
const std::string & | desc, | ||
bool | req, | ||
const std::string & | typeDesc, | ||
bool | ignoreable = false , |
||
Visitor * | v = NULL |
||
) |
Constructor.
name | - The name of the Arg. Note that this is used for identification, not as a long flag. |
desc | - A description of what the argument is for or does. |
req | - Whether the argument is required on the command line. |
typeDesc | - A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program. |
ignoreable | - Whether or not this argument can be ignored using the "--" flag. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 195 of file UnlabeledMultiArg.h.
References TCLAP::Arg::_ignoreable, TCLAP::OptionalUnlabeledTracker< DUMMY >::check(), and TCLAP::Arg::toString().
TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg | ( | const std::string & | name, |
const std::string & | desc, | ||
bool | req, | ||
const std::string & | typeDesc, | ||
CmdLineInterface & | parser, | ||
bool | ignoreable = false , |
||
Visitor * | v = NULL |
||
) |
Constructor.
name | - The name of the Arg. Note that this is used for identification, not as a long flag. |
desc | - A description of what the argument is for or does. |
req | - Whether the argument is required on the command line. |
typeDesc | - A short, human readable description of the type that this object expects. This is used in the generation of the USAGE statement. The goal is to be helpful to the end user of the program. |
parser | - A CmdLine parser object to add this Arg to |
ignoreable | - Whether or not this argument can be ignored using the "--" flag. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 208 of file UnlabeledMultiArg.h.
References TCLAP::Arg::_ignoreable, TCLAP::CmdLineInterface::add(), TCLAP::OptionalUnlabeledTracker< DUMMY >::check(), and TCLAP::Arg::toString().
TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg | ( | const std::string & | name, |
const std::string & | desc, | ||
bool | req, | ||
Constraint< T > * | constraint, | ||
bool | ignoreable = false , |
||
Visitor * | v = NULL |
||
) |
Constructor.
name | - The name of the Arg. Note that this is used for identification, not as a long flag. |
desc | - A description of what the argument is for or does. |
req | - Whether the argument is required on the command line. |
constraint | - A pointer to a Constraint object used to constrain this Arg. |
ignoreable | - Whether or not this argument can be ignored using the "--" flag. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 224 of file UnlabeledMultiArg.h.
References TCLAP::Arg::_ignoreable, TCLAP::OptionalUnlabeledTracker< DUMMY >::check(), and TCLAP::Arg::toString().
TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg | ( | const std::string & | name, |
const std::string & | desc, | ||
bool | req, | ||
Constraint< T > * | constraint, | ||
CmdLineInterface & | parser, | ||
bool | ignoreable = false , |
||
Visitor * | v = NULL |
||
) |
Constructor.
name | - The name of the Arg. Note that this is used for identification, not as a long flag. |
desc | - A description of what the argument is for or does. |
req | - Whether the argument is required on the command line. |
constraint | - A pointer to a Constraint object used to constrain this Arg. |
parser | - A CmdLine parser object to add this Arg to |
ignoreable | - Whether or not this argument can be ignored using the "--" flag. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 237 of file UnlabeledMultiArg.h.
References TCLAP::Arg::_ignoreable, TCLAP::CmdLineInterface::add(), TCLAP::OptionalUnlabeledTracker< DUMMY >::check(), and TCLAP::Arg::toString().
|
inlineprotectedinherited |
Performs the special handling described by the Vistitor.
Definition at line 519 of file Arg.h.
References TCLAP::Arg::_visitor, and TCLAP::Visitor::visit().
Referenced by TCLAP::SwitchArg::processArg().
|
protectedinherited |
Extracts the value from the string.
Attempts to parse string as type T, if this fails an exception is thrown.
val | - The string to be read. |
Definition at line 484 of file MultiArg.h.
References TCLAP::MULTI_ARG_HELPER::EXTRACT_FAILURE, TCLAP::MULTI_ARG_HELPER::EXTRACT_TOO_MANY, and TCLAP::MULTI_ARG_HELPER::ValueExtractor< T >::extractValue().
|
inlineinherited |
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 549 of file Arg.h.
References TCLAP::Arg::blankChar().
|
inlinevirtualinherited |
Definition at line 582 of file Arg.h.
References TCLAP::Arg::_acceptsMultipleValues.
Referenced by TCLAP::DocBookOutput::printShortArg().
|
virtual |
Pushes this to back of list rather than front.
argList | - The list this should be added to. |
Reimplemented from TCLAP::Arg.
Definition at line 304 of file UnlabeledMultiArg.h.
|
virtualinherited |
Reimplemented from TCLAP::Arg.
Definition at line 507 of file MultiArg.h.
|
inlinevirtualinherited |
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 498 of file Arg.h.
References TCLAP::Arg::_flag, TCLAP::Arg::_name, TCLAP::Arg::flagStartString(), and TCLAP::Arg::nameStartString().
Referenced by TCLAP::SwitchArg::processArg().
|
inlinestaticinherited |
Begin ignoring arguments since the "--" argument was specified.
Definition at line 178 of file Arg.h.
References TCLAP::Arg::ignoreRestRef().
Referenced by TCLAP::IgnoreRestVisitor::visit().
|
inlinestaticinherited |
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 196 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined(), TCLAP::Arg::_hasBlanks(), and TCLAP::SwitchArg::combinedSwitchesMatch().
|
inlinestaticinherited |
The delimiter that separates an argument flag/name from the value.
Definition at line 189 of file Arg.h.
References TCLAP::Arg::delimiterRef().
Referenced by TCLAP::MultiArg< T >::processArg(), TCLAP::ValueArg< T >::processArg(), TCLAP::Arg::shortID(), and TCLAP::Arg::trimFlag().
|
inlinestaticprivateinherited |
The delimiter that separates an argument flag/name from the value.
Definition at line 64 of file Arg.h.
Referenced by TCLAP::Arg::delimiter(), and TCLAP::Arg::setDelimiter().
|
inlinestaticinherited |
The char that indicates the beginning of a flag.
Currently '-'.
Definition at line 201 of file Arg.h.
Referenced by TCLAP::CmdLine::_emptyCombined().
|
inlinestaticinherited |
The sting that indicates the beginning of a flag.
Currently "-". Should be identical to flagStartChar.
Definition at line 207 of file Arg.h.
Referenced by TCLAP::CmdLine::_constructor(), TCLAP::Arg::Arg(), TCLAP::Arg::argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::Arg::longID(), TCLAP::Arg::shortID(), and TCLAP::Arg::toString().
|
inlineinherited |
Sets _required to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 558 of file Arg.h.
References TCLAP::Arg::_required.
|
inlineinherited |
Returns the argument description.
Definition at line 462 of file Arg.h.
References TCLAP::Arg::_description, TCLAP::Arg::_required, and TCLAP::Arg::_requireLabel.
Referenced by TCLAP::UnlabeledMultiArg< T >::operator==(), TCLAP::UnlabeledValueArg< T >::operator==(), and TCLAP::DocBookOutput::printLongArg().
|
inlineinherited |
|
inlineinherited |
Returns the argument name.
Definition at line 477 of file Arg.h.
References TCLAP::Arg::_name.
Referenced by TCLAP::UnlabeledMultiArg< T >::operator==(), and TCLAP::UnlabeledValueArg< T >::operator==().
|
inherited |
Returns a vector of type T containing the values parsed from the command line.
Definition at line 389 of file MultiArg.h.
|
inlinestaticinherited |
The name used to identify the ignore rest argument.
Definition at line 218 of file Arg.h.
Referenced by TCLAP::CmdLine::_constructor(), and TCLAP::Arg::Arg().
|
inlinestaticinherited |
Whether to ignore the rest.
Definition at line 183 of file Arg.h.
References TCLAP::Arg::ignoreRestRef().
Referenced by TCLAP::CmdLine::parse(), TCLAP::MultiArg< T >::processArg(), TCLAP::MultiSwitchArg< DUMMY >::processArg(), TCLAP::SwitchArg::processArg(), and TCLAP::ValueArg< T >::processArg().
|
inlinestaticprivateinherited |
Indicates whether the rest of the arguments should be ignored.
Definition at line 58 of file Arg.h.
Referenced by TCLAP::Arg::beginIgnoring(), and TCLAP::Arg::ignoreRest().
|
inlineinherited |
Indicates whether the argument can be ignored, if desired.
Definition at line 491 of file Arg.h.
References TCLAP::Arg::_ignoreable.
|
virtualinherited |
Once we've matched the first value, then the arg is no longer required.
Reimplemented from TCLAP::Arg.
Definition at line 469 of file MultiArg.h.
|
inlineinherited |
Indicates whether the argument has already been set.
Only true if the arg has been matched on the command line.
Definition at line 483 of file Arg.h.
References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.
|
inlineinherited |
Indicates whether a value must be specified for argument.
Definition at line 481 of file Arg.h.
References TCLAP::Arg::_valueRequired.
|
virtual |
Returns the a long id string.
Used in the usage.
val | - value to be used. |
Reimplemented from TCLAP::MultiArg< T >.
Definition at line 287 of file UnlabeledMultiArg.h.
|
inlinestaticinherited |
The sting that indicates the beginning of a name.
Currently "--". Should be flagStartChar twice.
Definition at line 213 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::Arg::longID(), TCLAP::Arg::shortID(), and TCLAP::Arg::toString().
|
virtual |
Opertor ==.
a | - The Arg to be compared to this. |
Reimplemented from TCLAP::Arg.
Definition at line 295 of file UnlabeledMultiArg.h.
References TCLAP::Arg::getDescription(), and TCLAP::Arg::getName().
|
virtual |
Handles the processing of the argument.
This re-implements the Arg version of this method to set the _value of the argument appropriately. It knows the difference between labeled and unlabeled.
i | - Pointer the the current argument in the list. |
args | - Mutable list of strings. Passed from main(). |
Reimplemented from TCLAP::MultiArg< T >.
Definition at line 253 of file UnlabeledMultiArg.h.
|
inlinestaticinherited |
Sets the delimiter for all arguments.
c | - The character that delimits flags/names from values. |
Definition at line 224 of file Arg.h.
References TCLAP::Arg::delimiterRef().
Referenced by TCLAP::CmdLine::_constructor().
|
inlineinherited |
Sets the requireLabel.
Used by XorHandler. You shouldn't ever use this.
s | - Set the requireLabel to this value. |
Definition at line 493 of file Arg.h.
References TCLAP::Arg::_requireLabel.
|
virtual |
Returns the a short id string.
Used in the usage.
val | - value to be used. |
Reimplemented from TCLAP::MultiArg< T >.
Definition at line 279 of file UnlabeledMultiArg.h.
|
inlinevirtualinherited |
Returns a simple string representation of the argument.
Primarily for debugging.
Definition at line 507 of file Arg.h.
References TCLAP::Arg::_flag, TCLAP::Arg::_name, TCLAP::Arg::flagStartString(), and TCLAP::Arg::nameStartString().
Referenced by TCLAP::Arg::Arg(), TCLAP::SwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
inlinevirtualinherited |
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 528 of file Arg.h.
References TCLAP::Arg::delimiter().
|
inlineinherited |
Sets the _alreadySet value to true.
This is used by the XorHandler. You really have no reason to ever use it.
Definition at line 563 of file Arg.h.
References TCLAP::Arg::_alreadySet, and TCLAP::Arg::_xorSet.
|
protectedinherited |
Definition at line 136 of file Arg.h.
Referenced by TCLAP::Arg::acceptsMultipleValues(), and TCLAP::MultiArg< T >::MultiArg().
|
protectedinherited |
Definition at line 183 of file MultiArg.h.
|
protectedinherited |
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 115 of file Arg.h.
Referenced by TCLAP::Arg::isSet(), TCLAP::SwitchArg::processArg(), and TCLAP::Arg::xorSet().
|
protectedinherited |
A list of constraint on this Arg.
Definition at line 173 of file MultiArg.h.
|
protectedinherited |
Description of the argument.
Definition at line 90 of file Arg.h.
Referenced by TCLAP::Arg::getDescription().
|
protectedinherited |
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 76 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::argMatches(), TCLAP::SwitchArg::combinedSwitchesMatch(), TCLAP::Arg::getFlag(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::shortID(), and TCLAP::Arg::toString().
|
protectedinherited |
Whether this argument can be ignored, if desired.
Definition at line 128 of file Arg.h.
Referenced by TCLAP::Arg::isIgnoreable(), TCLAP::SwitchArg::processArg(), TCLAP::UnlabeledMultiArg< T >::UnlabeledMultiArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().
|
protectedinherited |
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 85 of file Arg.h.
Referenced by TCLAP::Arg::Arg(), TCLAP::Arg::argMatches(), TCLAP::Arg::getName(), TCLAP::Arg::longID(), TCLAP::Arg::operator==(), TCLAP::Arg::shortID(), and TCLAP::Arg::toString().
|
protectedinherited |
Indicating whether the argument is required.
Definition at line 95 of file Arg.h.
Referenced by TCLAP::Arg::forceRequired(), TCLAP::Arg::getDescription(), TCLAP::Arg::isRequired(), and TCLAP::Arg::shortID().
|
protectedinherited |
Label to be used in usage description.
Normally set to "required", but can be changed when necessary.
Definition at line 101 of file Arg.h.
Referenced by TCLAP::Arg::getDescription(), and TCLAP::Arg::setRequireLabel().
|
protectedinherited |
The description of type T to be used in the usage.
Definition at line 168 of file MultiArg.h.
|
protectedinherited |
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 108 of file Arg.h.
Referenced by TCLAP::Arg::isValueRequired(), TCLAP::Arg::longID(), and TCLAP::Arg::shortID().
|
protectedinherited |
The list of values parsed from the CmdLine.
Definition at line 163 of file MultiArg.h.
|
protectedinherited |
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 123 of file Arg.h.
Referenced by TCLAP::Arg::_checkWithVisitor().
|
protectedinherited |
Indicates that the arg was set as part of an XOR and not on the command line.
Definition at line 134 of file Arg.h.
Referenced by TCLAP::Arg::isSet(), and TCLAP::Arg::xorSet().
Page generated by Doxygen 1.9.5 for MRPT 1.4.0 SVN: at Tue Dec 27 00:54:45 UTC 2022 |