The basic unlabeled 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 an UnlabeledValueArg is reached in the list of args that the CmdLine iterates over.
#include <mrpt/otherlibs/tclap/UnlabeledValueArg.h>
Public Member Functions | |
| UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL) | |
| UnlabeledValueArg constructor. | |
| UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL) | |
| UnlabeledValueArg constructor. | |
| UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, bool ignoreable=false, Visitor *v=NULL) | |
| UnlabeledValueArg constructor. | |
| UnlabeledValueArg (const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL) | |
| UnlabeledValueArg constructor. | |
| virtual bool | processArg (int *i, std::vector< std::string > &args) |
| Handles the processing of the argument. | |
| virtual std::string | shortID (const std::string &val="val") const |
| Overrides shortID for specific behavior. | |
| virtual std::string | longID (const std::string &val="val") const |
| Overrides longID for specific behavior. | |
| virtual bool | operator== (const Arg &a) const |
| Overrides operator== for specific behavior. | |
| virtual void | addToList (std::list< Arg * > &argList) const |
| Instead of pushing to the front of list, push to the back. | |
| T & | getValue () |
| Returns the value of the argument. | |
Protected Member Functions | |
| void | _extractValue (const std::string &val) |
| Extracts the value from the string. | |
Protected Attributes | |
| T | _value |
| The value parsed from the command line. | |
| std::string | _typeDesc |
| A human readable description of the type to be parsed. | |
| Constraint< T > * | _constraint |
| A Constraint this Arg must conform to. | |
| TCLAP::UnlabeledValueArg::UnlabeledValueArg | ( | const std::string & | name, |
| const std::string & | desc, | ||
| bool | req, | ||
| T | value, | ||
| const std::string & | typeDesc, | ||
| bool | ignoreable = false, |
||
| Visitor * | v = NULL |
||
| ) |
UnlabeledValueArg constructor.
Constructor implemenation.
| 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. |
| ignoreable | - Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored. |
| v | - Optional Vistor. You should leave this blank unless you have a very good reason. |
Definition at line 213 of file UnlabeledValueArg.h.
References TCLAP::OptionalUnlabeledTracker::check().
| TCLAP::UnlabeledValueArg::UnlabeledValueArg | ( | const std::string & | name, |
| const std::string & | desc, | ||
| bool | req, | ||
| T | value, | ||
| const std::string & | typeDesc, | ||
| CmdLineInterface & | parser, | ||
| bool | ignoreable = false, |
||
| Visitor * | v = NULL |
||
| ) |
UnlabeledValueArg constructor.
| 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 |
| ignoreable | - Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored. |
| v | - Optional Vistor. You should leave this blank unless you have a very good reason. |
Definition at line 229 of file UnlabeledValueArg.h.
References TCLAP::OptionalUnlabeledTracker::check(), and TCLAP::CmdLineInterface::add().
| TCLAP::UnlabeledValueArg::UnlabeledValueArg | ( | const std::string & | name, |
| const std::string & | desc, | ||
| bool | req, | ||
| T | value, | ||
| Constraint< T > * | constraint, | ||
| bool | ignoreable = false, |
||
| Visitor * | v = NULL |
||
| ) |
UnlabeledValueArg constructor.
Constructor implemenation.
| 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. |
| ignoreable | - Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored. |
| v | - Optional Vistor. You should leave this blank unless you have a very good reason. |
Definition at line 248 of file UnlabeledValueArg.h.
References TCLAP::OptionalUnlabeledTracker::check().
| TCLAP::UnlabeledValueArg::UnlabeledValueArg | ( | const std::string & | name, |
| const std::string & | desc, | ||
| bool | req, | ||
| T | value, | ||
| Constraint< T > * | constraint, | ||
| CmdLineInterface & | parser, | ||
| bool | ignoreable = false, |
||
| Visitor * | v = NULL |
||
| ) |
UnlabeledValueArg constructor.
| 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 |
| ignoreable | - Allows you to specify that this argument can be ignored if the '--' flag is set. This defaults to false (cannot be ignored) and should generally stay that way unless you have some special need for certain arguments to be ignored. |
| v | - Optional Vistor. You should leave this blank unless you have a very good reason. |
Definition at line 262 of file UnlabeledValueArg.h.
References TCLAP::OptionalUnlabeledTracker::check(), and TCLAP::CmdLineInterface::add().
| void TCLAP::ValueArg::_extractValue | ( | const std::string & | val | ) | [protected, inherited] |
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. |
Instead of pushing to the front of list, push to the back.
| argList | - The list to add this to. |
Definition at line 335 of file UnlabeledValueArg.h.
| T& TCLAP::ValueArg::getValue | ( | ) | [inherited] |
Returns the value of the argument.
Implementation of getValue().
| std::string TCLAP::UnlabeledValueArg::longID | ( | const std::string & | val = "val" | ) | const [virtual] |
Overrides longID for specific behavior.
Overriding longID for specific output.
Reimplemented from TCLAP::ValueArg< T >.
Definition at line 312 of file UnlabeledValueArg.h.
| bool TCLAP::UnlabeledValueArg::operator== | ( | const Arg & | a | ) | const [virtual] |
Overrides operator== for specific behavior.
Overriding operator== for specific behavior.
Definition at line 326 of file UnlabeledValueArg.h.
References TCLAP::Arg::getName(), and TCLAP::Arg::getDescription().
| bool TCLAP::UnlabeledValueArg::processArg | ( | int * | i, |
| std::vector< std::string > & | args | ||
| ) | [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. Handling specific to unlabled arguments.
| i | - Pointer the the current argument in the list. |
| args | - Mutable list of strings. |
Reimplemented from TCLAP::ValueArg< T >.
Definition at line 281 of file UnlabeledValueArg.h.
| std::string TCLAP::UnlabeledValueArg::shortID | ( | const std::string & | val = "val" | ) | const [virtual] |
Overrides shortID for specific behavior.
Overriding shortID for specific output.
Reimplemented from TCLAP::ValueArg< T >.
Definition at line 301 of file UnlabeledValueArg.h.
Constraint<T>* TCLAP::ValueArg::_constraint [protected, inherited] |
A Constraint this Arg must conform to.
Definition at line 193 of file ValueArg.h.
std::string TCLAP::ValueArg::_typeDesc [protected, inherited] |
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 188 of file ValueArg.h.
T TCLAP::ValueArg::_value [protected, inherited] |
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 179 of file ValueArg.h.
| Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011 |