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

Detailed Description

template<class T>
class TCLAP::UnlabeledMultiArg< T >

Just like a MultiArg, except that the arguments are unlabeled.

Basically, this Arg will slurp up everything that hasn't been matched to another Arg.

Definition at line 66 of file UnlabeledMultiArg.h.

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

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

Public Member Functions

 UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, bool ignoreable=false, Visitor *v=NULL)
 Constructor. More...
 
 UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, const std::string &typeDesc, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
 Constructor. More...
 
 UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, bool ignoreable=false, Visitor *v=NULL)
 Constructor. More...
 
 UnlabeledMultiArg (const std::string &name, const std::string &desc, bool req, Constraint< T > *constraint, CmdLineInterface &parser, bool ignoreable=false, Visitor *v=NULL)
 Constructor. More...
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 Handles the processing of the argument. 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 operator== (const Arg &a) const
 Opertor ==. More...
 
virtual void addToList (std::list< Arg * > &argList) const
 Pushes this to back of list rather than front. More...
 
const std::vector< T > & getValue ()
 Returns a vector of type T containing the values parsed from the command line. 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

◆ UnlabeledMultiArg() [1/4]

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

Constructor.

Parameters
name- The name of the Arg. Note that this is used for identification, not as a long flag.
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.
ignoreable- Whether or not this argument can be ignored using the "--" flag.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 213 of file UnlabeledMultiArg.h.

References TCLAP::OptionalUnlabeledTracker< DUMMY >::check().

◆ UnlabeledMultiArg() [2/4]

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

Constructor.

Parameters
name- The name of the Arg. Note that this is used for identification, not as a long flag.
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
ignoreable- Whether or not this argument can be ignored using the "--" flag.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 226 of file UnlabeledMultiArg.h.

References TCLAP::OptionalUnlabeledTracker< DUMMY >::check().

◆ UnlabeledMultiArg() [3/4]

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

Constructor.

Parameters
name- The name of the Arg. Note that this is used for identification, not as a long flag.
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.
ignoreable- Whether or not this argument can be ignored using the "--" flag.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 242 of file UnlabeledMultiArg.h.

References TCLAP::CmdLineInterface::add(), and TCLAP::OptionalUnlabeledTracker< DUMMY >::check().

◆ UnlabeledMultiArg() [4/4]

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

Constructor.

Parameters
name- The name of the Arg. Note that this is used for identification, not as a long flag.
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
ignoreable- Whether or not this argument can be ignored using the "--" flag.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 255 of file UnlabeledMultiArg.h.

Member Function Documentation

◆ _extractValue()

template<class T >
void TCLAP::MultiArg< T >::_extractValue ( const std::string &  val)
protectedinherited

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

◆ addToList()

template<class T >
void TCLAP::UnlabeledMultiArg< T >::addToList ( std::list< Arg * > &  argList) const
virtual

Pushes this to back of list rather than front.

Parameters
argList- The list this should be added to.

Definition at line 322 of file UnlabeledMultiArg.h.

◆ allowMore()

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

Definition at line 507 of file MultiArg.h.

◆ getValue()

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

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
virtualinherited

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::UnlabeledMultiArg< 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 from TCLAP::MultiArg< T >.

Definition at line 305 of file UnlabeledMultiArg.h.

◆ operator==()

template<class T >
bool TCLAP::UnlabeledMultiArg< T >::operator== ( const Arg a) const
virtual

Opertor ==.

Parameters
a- The Arg to be compared to this.

Definition at line 313 of file UnlabeledMultiArg.h.

◆ processArg()

template<class T >
bool TCLAP::UnlabeledMultiArg< 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 from TCLAP::MultiArg< T >.

Definition at line 271 of file UnlabeledMultiArg.h.

◆ shortID()

template<class T >
std::string TCLAP::UnlabeledMultiArg< 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 from TCLAP::MultiArg< T >.

Definition at line 297 of file UnlabeledMultiArg.h.

Member Data Documentation

◆ _allowMore

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

Definition at line 183 of file MultiArg.h.

◆ _constraint

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

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
protectedinherited

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
protectedinherited

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 Tue Mar 3 09:15:16 UTC 2020