The basic labeled argument that parses a value.
This is a template class, which means the type T defines the type that a given object will attempt to parse when the flag/name is matched on the command line. While there is nothing stopping you from creating an unflagged ValueArg, it is unwise and would cause significant problems. Instead use an UnlabeledValueArg.
Definition at line 159 of file ValueArg.h.
#include <mrpt/otherlibs/tclap/ValueArg.h>
Public Member Functions | |
ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, Visitor *v=NULL) | |
Labeled ValueArg constructor. More... | |
ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL) | |
Labeled ValueArg constructor. More... | |
ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL) | |
Labeled ValueArg constructor. More... | |
ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, Visitor *v=NULL) | |
Labeled ValueArg constructor. More... | |
virtual bool | processArg (int *i, std::vector< std::string > &args) |
Handles the processing of the argument. More... | |
T & | getValue () |
Returns the value of the argument. More... | |
virtual std::string | shortID (const std::string &val="val") const |
Specialization of shortID. More... | |
virtual std::string | longID (const std::string &val="val") const |
Specialization of longID. More... | |
virtual void | addToList (std::list< Arg * > &argList) const |
Adds this to the specified list of Args. More... | |
virtual bool | operator== (const Arg &a) const |
Operator ==. More... | |
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... | |
virtual bool | isRequired () const |
Indicates whether the argument is required. 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 | allowMore () |
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 | |
T | _value |
The value parsed from the command line. More... | |
std::string | _typeDesc |
A human readable description of the type to be parsed. More... | |
Constraint< T > * | _constraint |
A Constraint this Arg must conform to. More... | |
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::ValueArg< T >::ValueArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
bool | req, | ||
T | value, | ||
const std::string & | typeDesc, | ||
Visitor * | v = NULL |
||
) |
Labeled ValueArg constructor.
Constructor implementation.
You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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. |
req | - Whether the argument is required on the command line. |
value | - The default value assigned to this argument if it is not present 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. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 354 of file ValueArg.h.
TCLAP::ValueArg< T >::ValueArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
bool | req, | ||
T | value, | ||
const std::string & | typeDesc, | ||
CmdLineInterface & | parser, | ||
Visitor * | v = NULL |
||
) |
Labeled ValueArg constructor.
You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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. |
req | - Whether the argument is required on the command line. |
value | - The default value assigned to this argument if it is not present 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 |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 368 of file ValueArg.h.
References TCLAP::CmdLineInterface::add().
TCLAP::ValueArg< T >::ValueArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
bool | req, | ||
T | value, | ||
Constraint< T > * | constraint, | ||
CmdLineInterface & | parser, | ||
Visitor * | v = NULL |
||
) |
Labeled ValueArg constructor.
You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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. |
req | - Whether the argument is required on the command line. |
value | - The default value assigned to this argument if it is not present 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. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 399 of file ValueArg.h.
References TCLAP::CmdLineInterface::add().
TCLAP::ValueArg< T >::ValueArg | ( | const std::string & | flag, |
const std::string & | name, | ||
const std::string & | desc, | ||
bool | req, | ||
T | value, | ||
Constraint< T > * | constraint, | ||
Visitor * | v = NULL |
||
) |
Labeled ValueArg constructor.
You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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. |
req | - Whether the argument is required on the command line. |
value | - The default value assigned to this argument if it is not present on the command line. |
constraint | - A pointer to a Constraint object used to constrain this Arg. |
v | - An optional visitor. You probably should not use this unless you have a very good reason. |
Definition at line 385 of file ValueArg.h.
|
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().
|
protected |
Extracts the value from the string.
Attempts to parse string as type T, if this fails an exception is thrown.
val | - value to be parsed. |
Definition at line 488 of file ValueArg.h.
References TCLAP::VALUE_ARG_HELPER::EXTRACT_FAILURE, TCLAP::VALUE_ARG_HELPER::EXTRACT_TOO_MANY, and TCLAP::VALUE_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().
|
inlinevirtualinherited |
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. |
Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.
Definition at line 572 of file Arg.h.
Referenced by TCLAP::CmdLine::add().
|
inlinevirtualinherited |
Reimplemented in TCLAP::MultiArg< T >.
|
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==().
T & TCLAP::ValueArg< T >::getValue |
Returns the value of the argument.
Implementation of getValue().
Definition at line 420 of file ValueArg.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.
|
inlinevirtualinherited |
Indicates whether the argument is required.
Reimplemented in TCLAP::MultiArg< T >.
Definition at line 479 of file Arg.h.
References TCLAP::Arg::_required.
Referenced by TCLAP::CmdLine::add(), TCLAP::XorHandler::check(), and TCLAP::DocBookOutput::printShortArg().
|
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 |
Specialization of longID.
Implementation of longID.
val | - value to be used. |
Reimplemented from TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledValueArg< T >.
Definition at line 482 of file ValueArg.h.
References TCLAP::Arg::longID().
|
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().
|
inlinevirtualinherited |
Operator ==.
Equality operator. Must be virtual to handle unlabeled args.
a | - The Arg to be compared to this. |
Reimplemented in TCLAP::UnlabeledMultiArg< T >, and TCLAP::UnlabeledValueArg< T >.
Definition at line 454 of file Arg.h.
References TCLAP::Arg::_flag, and TCLAP::Arg::_name.
|
virtual |
Handles the processing of the argument.
Implementation of processArg().
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 in from main(). |
Implements TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledValueArg< T >.
Definition at line 426 of file ValueArg.h.
References TCLAP::Arg::delimiter(), and TCLAP::Arg::ignoreRest().
|
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 |
Specialization of shortID.
Implementation of shortID.
val | - value to be used. |
Reimplemented from TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledValueArg< T >.
Definition at line 473 of file ValueArg.h.
References TCLAP::Arg::shortID().
|
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 |
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().
|
protected |
A Constraint this Arg must conform to.
Definition at line 182 of file ValueArg.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().
|
protected |
A human readable description of the type to be parsed.
This is a hack, plain and simple. Ideally we would use RTTI to return the name of type T, but until there is some sort of consistent support for human readable names, we are left to our own devices.
Definition at line 177 of file ValueArg.h.
|
protected |
The value parsed from the command line.
Can be of any type, as long as the >> operator for the type is defined.
Definition at line 168 of file ValueArg.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 |
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 Sun Nov 27 02:47:40 UTC 2022 |