Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
TCLAP::MultiArg< T > Class Template Reference

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 37 of file MultiArg.h.

#include <mrpt/otherlibs/tclap/MultiArg.h>

Inheritance diagram for TCLAP::MultiArg< T >:
Inheritance graph

Public Member Functions

 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, Visitor *v=NULL)
 Constructor. More...
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
 Constructor. More...
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, Visitor *v=NULL)
 Constructor. More...
 
 MultiArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL)
 Constructor. More...
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 Handles the processing of the argument. More...
 
const std::vector< T > & getValue ()
 Returns a vector of type T containing the values parsed from the command line. 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 isRequired () const
 Once we've matched the first value, then the arg is no longer required. More...
 
virtual bool allowMore ()
 

Protected Member Functions

void _extractValue (const std::string &val)
 Extracts the value from the string. 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
 

Constructor & Destructor Documentation

◆ MultiArg() [1/4]

template<class T >
TCLAP::MultiArg< T >::MultiArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
const std::string &  typeDesc,
Visitor v = NULL 
)

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 322 of file MultiArg.h.

◆ MultiArg() [2/4]

template<class T >
TCLAP::MultiArg< T >::MultiArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
const std::string &  typeDesc,
CmdLineInterface parser,
Visitor v = NULL 
)

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 337 of file MultiArg.h.

References TCLAP::CmdLineInterface::add().

◆ MultiArg() [3/4]

template<class T >
TCLAP::MultiArg< T >::MultiArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
Constraint< T > *  constraint,
Visitor v = NULL 
)

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 357 of file MultiArg.h.

◆ MultiArg() [4/4]

template<class T >
TCLAP::MultiArg< T >::MultiArg ( const std::string &  flag,
const std::string &  name,
const std::string &  desc,
bool  req,
Constraint< T > *  constraint,
CmdLineInterface parser,
Visitor v = NULL 
)

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 372 of file MultiArg.h.

References TCLAP::CmdLineInterface::add().

Member Function Documentation

◆ _extractValue()

template<class 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 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().

◆ allowMore()

template<class T >
bool TCLAP::MultiArg< T >::allowMore
virtual

Definition at line 507 of file MultiArg.h.

◆ getValue()

template<class T >
const std::vector< T > & TCLAP::MultiArg< T >::getValue

Returns a vector of type T containing the values parsed from the command line.

Definition at line 389 of file MultiArg.h.

◆ isRequired()

template<class T >
bool TCLAP::MultiArg< T >::isRequired
virtual

Once we've matched the first value, then the arg is no longer required.

Definition at line 469 of file MultiArg.h.

◆ longID()

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

Returns the a long id string.

Used in the usage.

Parameters
val- value to be used.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

Definition at line 457 of file MultiArg.h.

References TCLAP::Arg::longID().

◆ processArg()

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

Parameters
i- Pointer the the current argument in the list.
args- Mutable list of strings. Passed from main().

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

Definition at line 392 of file MultiArg.h.

References TCLAP::Arg::delimiter(), and TCLAP::Arg::ignoreRest().

◆ shortID()

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

Returns the a short id string.

Used in the usage.

Parameters
val- value to be used.

Reimplemented in TCLAP::UnlabeledMultiArg< T >.

Definition at line 446 of file MultiArg.h.

References TCLAP::Arg::shortID().

Member Data Documentation

◆ _allowMore

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

Definition at line 183 of file MultiArg.h.

◆ _constraint

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

A list of constraint on this Arg.

Definition at line 173 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 168 of file MultiArg.h.

◆ _values

template<class T >
std::vector<T> TCLAP::MultiArg< T >::_values
protected

The list of values parsed from the CmdLine.

Definition at line 163 of file MultiArg.h.




Page generated by Doxygen 1.8.17 for MRPT 1.4.0 SVN: at Sat Jan 18 22:37:07 UTC 2020