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

Detailed Description

template<class T>
class TCLAP::ValueArg< T >

The basic labeled 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 the flag/name is matched on the command line. While there is nothing stopping you from creating an unflagged ValueArg, it is unwise and would cause significant problems. Instead use an UnlabeledValueArg.

Definition at line 159 of file ValueArg.h.

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

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

Public Member Functions

 ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, Visitor *v=NULL)
 Labeled ValueArg constructor. More...
 
 ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, const std::string &typeDesc, CmdLineInterface &parser, Visitor *v=NULL)
 Labeled ValueArg constructor. More...
 
 ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, CmdLineInterface &parser, Visitor *v=NULL)
 Labeled ValueArg constructor. More...
 
 ValueArg (const std::string &flag, const std::string &name, const std::string &desc, bool req, T value, Constraint< T > *constraint, Visitor *v=NULL)
 Labeled ValueArg constructor. More...
 
virtual bool processArg (int *i, std::vector< std::string > &args)
 Handles the processing of the argument. More...
 
T & getValue ()
 Returns the value of the argument. More...
 
virtual std::string shortID (const std::string &val="val") const
 Specialization of shortID. More...
 
virtual std::string longID (const std::string &val="val") const
 Specialization of longID. More...
 

Protected Member Functions

void _extractValue (const std::string &val)
 Extracts the value from the string. More...
 

Protected Attributes

_value
 The value parsed from the command line. More...
 
std::string _typeDesc
 A human readable description of the type to be parsed. More...
 
Constraint< T > * _constraint
 A Constraint this Arg must conform to. More...
 

Constructor & Destructor Documentation

◆ ValueArg() [1/4]

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

Labeled ValueArg constructor.

Constructor implementation.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
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.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 354 of file ValueArg.h.

◆ ValueArg() [2/4]

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

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
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
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 368 of file ValueArg.h.

References TCLAP::CmdLineInterface::add().

◆ ValueArg() [3/4]

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

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
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.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 399 of file ValueArg.h.

References TCLAP::CmdLineInterface::add().

◆ ValueArg() [4/4]

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

Labeled ValueArg constructor.

You could conceivably call this constructor with a blank flag, but that would make you a bad person. It would also cause an exception to be thrown. If you want an unlabeled argument, use the other 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.
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.
v- An optional visitor. You probably should not use this unless you have a very good reason.

Definition at line 385 of file ValueArg.h.

Member Function Documentation

◆ _extractValue()

template<class T >
void TCLAP::ValueArg< 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- value to be parsed.

Definition at line 488 of file ValueArg.h.

◆ getValue()

template<class T >
T & TCLAP::ValueArg< T >::getValue

Returns the value of the argument.

Implementation of getValue().

Definition at line 420 of file ValueArg.h.

◆ longID()

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

Specialization of longID.

Implementation of longID.

Parameters
val- value to be used.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 482 of file ValueArg.h.

References TCLAP::Arg::longID().

◆ processArg()

template<class T >
bool TCLAP::ValueArg< T >::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. It knows the difference between labeled and unlabeled.

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

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 426 of file ValueArg.h.

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

◆ shortID()

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

Specialization of shortID.

Implementation of shortID.

Parameters
val- value to be used.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 473 of file ValueArg.h.

References TCLAP::Arg::shortID().

Member Data Documentation

◆ _constraint

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

A Constraint this Arg must conform to.

Definition at line 182 of file ValueArg.h.

◆ _typeDesc

template<class T >
std::string TCLAP::ValueArg< T >::_typeDesc
protected

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 177 of file ValueArg.h.

◆ _value

template<class T >
T TCLAP::ValueArg< T >::_value
protected

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 168 of file ValueArg.h.




Page generated by Doxygen 1.8.20 for MRPT 1.4.0 SVN: at Thu Aug 27 02:40:23 UTC 2020