tclap 1.6.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TCLAP::MultiArg< T > Class Template Reference

An argument that allows multiple values of type T to be specified. More...

#include <MultiArg.h>

Inheritance diagram for TCLAP::MultiArg< T >:
Inheritance graph
[legend]
Collaboration diagram for TCLAP::MultiArg< T >:
Collaboration graph
[legend]

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.
 

Detailed Description

template<class T>
class TCLAP::MultiArg< T >

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.

Member Typedef Documentation

◆ const_iterator

template<class T >
using TCLAP::MultiArg< T >::const_iterator = typename container_type::const_iterator

Definition at line 47 of file MultiArg.h.

◆ container_type

template<class T >
using TCLAP::MultiArg< T >::container_type = std::vector<T>

Definition at line 45 of file MultiArg.h.

◆ iterator

template<class T >
using TCLAP::MultiArg< T >::iterator = typename container_type::iterator

Definition at line 46 of file MultiArg.h.

Constructor & Destructor Documentation

◆ MultiArg() [1/5]

template<class T >
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.

Parameters
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.

◆ MultiArg() [2/5]

template<class T >
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.

Parameters
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().

Here is the call graph for this function:

◆ MultiArg() [3/5]

template<class T >
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.

Parameters
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.

◆ MultiArg() [4/5]

template<class T >
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.

Parameters
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().

Here is the call graph for this function:

◆ MultiArg() [5/5]

template<class T >
TCLAP::MultiArg< T >::MultiArg ( const MultiArg< T > &  rhs)
delete

Prevent accidental copying.

Member Function Documentation

◆ _extractValue()

template<class T >
requires detail::ValidArgValueType<T> && std::default_initializable<T>
void TCLAP::MultiArg< T >::_extractValue ( const std::string &  val)
protected

Extracts the value from the string.

Attempts to parse string as type T, if this fails an exception is thrown.

Parameters
val- The string to be read.

Definition at line 330 of file MultiArg.h.

References TCLAP::ArgException::error(), and TCLAP::ExtractValue().

Here is the call graph for this function:

◆ allowMore()

template<class T >
bool TCLAP::MultiArg< T >::allowMore ( )
overridevirtual

Used for MultiArgs to determine whether args can still be set.

Reimplemented from TCLAP::Arg.

Definition at line 349 of file MultiArg.h.

◆ begin()

template<class T >
const_iterator TCLAP::MultiArg< T >::begin ( ) const
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.

◆ end()

template<class T >
const_iterator TCLAP::MultiArg< T >::end ( ) const
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.

◆ getValue()

template<class T >
const std::vector< T > & TCLAP::MultiArg< T >::getValue ( ) const
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.

◆ longID()

template<class T >
std::string TCLAP::MultiArg< T >::longID ( const std::string &  val = "val") const
overridevirtual

Returns the a long id string.

Used in the usage.

Parameters
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().

Here is the call graph for this function:

◆ operator=()

template<class T >
MultiArg & TCLAP::MultiArg< T >::operator= ( const MultiArg< T > &  rhs)
delete

◆ processArg()

template<class T >
bool TCLAP::MultiArg< T >::processArg ( int *  i,
std::vector< std::string > &  args 
)
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.

Parameters
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.

◆ reset()

template<class T >
void TCLAP::MultiArg< T >::reset ( )
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().

Here is the call graph for this function:

◆ shortID()

template<class T >
std::string TCLAP::MultiArg< T >::shortID ( const std::string &  val = "val") const
overridevirtual

Returns the a short id string.

Used in the usage.

Parameters
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().

Here is the call graph for this function:

Member Data Documentation

◆ _allowMore

template<class T >
bool TCLAP::MultiArg< T >::_allowMore
protected

Used by MultiArg to decide whether to keep parsing for this arg.

Definition at line 78 of file MultiArg.h.

◆ _constraint

template<class T >
const Constraint<T>* TCLAP::MultiArg< T >::_constraint
protected

A constraint that the values of this Arg must conform to.

Definition at line 63 of file MultiArg.h.

◆ _typeDesc

template<class T >
std::string TCLAP::MultiArg< T >::_typeDesc
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().

◆ _values

template<class T >
std::vector<T> TCLAP::MultiArg< T >::_values
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().


The documentation for this class was generated from the following file: