|
tclap 1.6.0
|
An argument that allows multiple values of type T to be specified. More...
#include <MultiArg.h>


Public Types | |
| using | container_type = std::vector< T > |
| using | iterator = typename container_type::iterator |
| using | const_iterator = typename container_type::const_iterator |
Public Member Functions | |
| MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, std::string typeDesc, Visitor *v=nullptr) | |
| Constructor. | |
| MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, std::string typeDesc, ArgContainer &parser, Visitor *v=nullptr) | |
| Constructor. | |
| MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const Constraint< T > *constraint, Visitor *v=nullptr) | |
| Constructor. | |
| MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const Constraint< T > *constraint, ArgContainer &parser, Visitor *v=nullptr) | |
| Constructor. | |
| bool | processArg (int *i, std::vector< std::string > &args) override |
| Handles the processing of the argument. | |
| const std::vector< T > & | getValue () const noexcept |
| Returns a vector of type T containing the values parsed from the command line. | |
| const_iterator | begin () const noexcept |
| Returns an iterator over the values parsed from the command line. | |
| const_iterator | end () const noexcept |
| Returns the end of the values parsed from the command line. | |
| std::string | shortID (const std::string &val="val") const override |
| Returns the a short id string. | |
| std::string | longID (const std::string &val="val") const override |
| Returns the a long id string. | |
| bool | allowMore () override |
| Used for MultiArgs to determine whether args can still be set. | |
| void | reset () override |
| Clears the Arg object and allows it to be reused by new command lines. | |
| MultiArg (const MultiArg< T > &rhs)=delete | |
| Prevent accidental copying. | |
| MultiArg & | operator= (const MultiArg< T > &rhs)=delete |
Public Member Functions inherited from TCLAP::Arg | |
| Arg (const Arg &rhs)=delete | |
| Prevent accidental copying. | |
| Arg & | operator= (const Arg &rhs)=delete |
| Arg & | addAlias (std::string flag, std::string name={}) |
| Add equivalent spellings before registration. | |
| const std::vector< ArgAlias > & | aliases () const noexcept |
| Alias spellings in insertion order; no prefixes are stored. | |
| virtual | ~Arg ()=default |
| Destructor. | |
| virtual void | addToList (std::list< Arg * > &argList) const |
| Adds this to the specified list of Args. | |
| char | getDelimiter () const |
| Returns this argument's parser delimiter, or the legacy default. | |
| virtual bool | operator== (const Arg &a) const |
| Operator ==. | |
| bool | conflictsWith (const Arg &a) const noexcept |
| Checks declared registration conflicts: the same object, the same name, or the same nonempty short flag, including aliases. | |
| const std::string & | getFlag () const noexcept |
| Returns the argument flag. | |
| const std::string & | getName () const noexcept |
| Returns the argument name. | |
| std::string | getDescription () const |
| Returns the argument description. | |
| virtual void | setDescription (const std::string &desc) |
| Updates the argument description. | |
| std::string | getDescription (bool required) const |
| Returns the argument description. | |
| virtual bool | isRequired () const |
| Indicates whether the argument is required. | |
| bool | isValueRequired () const noexcept |
| Indicates whether a value must be specified for argument. | |
| bool | isSet () const noexcept |
| Indicates whether the argument has already been set. | |
| const std::string & | setBy () const noexcept |
| Returns the value specified to set this flag (like -a or –all). | |
| bool | isIgnoreable () const noexcept |
| 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. | |
| virtual bool | acceptsMultipleValues () |
| Use by output classes to determine whether an Arg accepts multiple values. | |
| virtual void | hideFromHelp (bool hide=true) |
| Hide this argument from the help output (e.g., when specifying the –help flag or on error. | |
| virtual bool | visibleInHelp () const |
| Returns true if this Arg is visible in the help output. | |
| virtual bool | hasLabel () const |
Protected Member Functions | |
| void | _extractValue (const std::string &val) |
| Extracts the value from the string. | |
Protected Member Functions inherited from TCLAP::Arg | |
| bool | matchesShortFlag (const std::string &flag) const |
| bool | matchesLongName (const std::string &name) const |
| void | _checkWithVisitor () const |
| Performs the special handling described by the Visitor. | |
| Arg (std::string flag, std::string name, std::string desc, bool req, bool valreq, Visitor *v=nullptr) | |
| Primary constructor. | |
Protected Attributes | |
| std::vector< T > | _values |
| The list of values parsed from the CmdLine. | |
| std::string | _typeDesc |
| The description of type T to be used in the usage. | |
| const Constraint< T > * | _constraint |
| A constraint that the values of this Arg must conform to. | |
| bool | _allowMore |
| Used by MultiArg to decide whether to keep parsing for this arg. | |
Protected Attributes inherited from TCLAP::Arg | |
| std::string | _flag |
| The single char flag used to identify the argument. | |
| std::string | _name |
| A single word namd identifying the argument. | |
| std::string | _description |
| Description of the argument. | |
| const 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. | |
| std::string | _setBy |
| Indicates the value specified to set this flag (like -a or –all). | |
| Visitor * | _visitor |
| A pointer to a visitor object. | |
| bool | _ignoreable |
| Whether this argument can be ignored, if desired. | |
| bool | _acceptsMultipleValues |
| bool | _visibleInHelp |
| Indicates if the argument is visible in the help output (e.g., when specifying –help). | |
Additional Inherited Members | |
Static Public Member Functions inherited from TCLAP::Arg | |
| static char | delimiter () |
| The delimiter that separates an argument flag/name from the value. | |
| static constexpr char | blankChar () noexcept |
| The char used as a place holder when SwitchArgs are combined. | |
| static constexpr char | flagStartChar () noexcept |
| static std::string | flagStartString () |
| static std::string | nameStartString () |
| static std::string | ignoreNameString () |
| The name used to identify the ignore rest argument. | |
| static void | setDelimiter (char c) |
| Sets the legacy delimiter for unregistered arguments and static callers. | |
An argument that allows multiple values of type T to be specified.
Very similar to a ValueArg, except a vector of values will be returned instead of just one.
Definition at line 43 of file MultiArg.h.
| using TCLAP::MultiArg< T >::const_iterator = typename container_type::const_iterator |
Definition at line 47 of file MultiArg.h.
| using TCLAP::MultiArg< T >::container_type = std::vector<T> |
Definition at line 45 of file MultiArg.h.
| using TCLAP::MultiArg< T >::iterator = typename container_type::iterator |
Definition at line 46 of file MultiArg.h.
| TCLAP::MultiArg< T >::MultiArg | ( | const std::string & | flag, |
| const std::string & | name, | ||
| const std::string & | desc, | ||
| bool | req, | ||
| std::string | typeDesc, | ||
| Visitor * | v = nullptr |
||
| ) |
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. |
| 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 220 of file MultiArg.h.
References TCLAP::Arg::_acceptsMultipleValues.
| TCLAP::MultiArg< T >::MultiArg | ( | const std::string & | flag, |
| const std::string & | name, | ||
| const std::string & | desc, | ||
| bool | req, | ||
| std::string | typeDesc, | ||
| ArgContainer & | parser, | ||
| Visitor * | v = nullptr |
||
| ) |
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. |
| 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 232 of file MultiArg.h.
References TCLAP::Arg::_acceptsMultipleValues, and TCLAP::ArgContainer::add().

| TCLAP::MultiArg< T >::MultiArg | ( | const std::string & | flag, |
| const std::string & | name, | ||
| const std::string & | desc, | ||
| bool | req, | ||
| const Constraint< T > * | constraint, | ||
| Visitor * | v = nullptr |
||
| ) |
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. |
| 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 249 of file MultiArg.h.
References TCLAP::Arg::_acceptsMultipleValues.
| TCLAP::MultiArg< T >::MultiArg | ( | const std::string & | flag, |
| const std::string & | name, | ||
| const std::string & | desc, | ||
| bool | req, | ||
| const Constraint< T > * | constraint, | ||
| ArgContainer & | parser, | ||
| Visitor * | v = nullptr |
||
| ) |
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. |
| 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 261 of file MultiArg.h.
References TCLAP::Arg::_acceptsMultipleValues, and TCLAP::ArgContainer::add().

|
delete |
Prevent accidental copying.
|
protected |
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 330 of file MultiArg.h.
References TCLAP::ArgException::error(), and TCLAP::ExtractValue().

|
overridevirtual |
Used for MultiArgs to determine whether args can still be set.
Reimplemented from TCLAP::Arg.
Definition at line 349 of file MultiArg.h.
|
inlinenoexcept |
Returns an iterator over the values parsed from the command line.
Definition at line 183 of file MultiArg.h.
References TCLAP::MultiArg< T >::_values.
|
inlinenoexcept |
Returns the end of the values parsed from the command line.
Definition at line 189 of file MultiArg.h.
References TCLAP::MultiArg< T >::_values.
|
inlinenoexcept |
Returns a vector of type T containing the values parsed from the command line.
Definition at line 177 of file MultiArg.h.
References TCLAP::MultiArg< T >::_values.
|
overridevirtual |
Returns the a long id string.
Used in the usage.
| val | - value to be used. |
Reimplemented from TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledMultiArg< T >.
Definition at line 324 of file MultiArg.h.
References TCLAP::Arg::longID().

|
delete |
|
overridevirtual |
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(). |
Implements TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledMultiArg< T >.
Definition at line 275 of file MultiArg.h.
|
overridevirtual |
Clears the Arg object and allows it to be reused by new command lines.
Reimplemented from TCLAP::Arg.
Definition at line 356 of file MultiArg.h.
References TCLAP::Arg::reset().

|
overridevirtual |
Returns the a short id string.
Used in the usage.
| val | - value to be used. |
Reimplemented from TCLAP::Arg.
Reimplemented in TCLAP::UnlabeledMultiArg< T >.
Definition at line 315 of file MultiArg.h.
References TCLAP::Arg::shortID().

|
protected |
Used by MultiArg to decide whether to keep parsing for this arg.
Definition at line 78 of file MultiArg.h.
|
protected |
A constraint that the values of this Arg must conform to.
Definition at line 63 of file MultiArg.h.
|
protected |
The description of type T to be used in the usage.
Definition at line 58 of file MultiArg.h.
Referenced by TCLAP::UnlabeledMultiArg< T >::longID().
|
protected |
The list of values parsed from the CmdLine.
Definition at line 53 of file MultiArg.h.
Referenced by TCLAP::MultiArg< T >::begin(), TCLAP::MultiArg< T >::end(), and TCLAP::MultiArg< T >::getValue().