TCLAP::ValueArg< T > Class Template Reference

The basic labeled argument that parses a value. More...

#include <ValueArg.h>

Inheritance diagram for TCLAP::ValueArg< T >:

TCLAP::Arg TCLAP::UnlabeledValueArg< T > List of all members.

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)
 Constructor implementation.
 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.
 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.
 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.
virtual bool processArg (int *i, std::vector< std::string > &args)
 Implementation of processArg().
T & getValue ()
 Implementation of getValue().
virtual std::string shortID (const std::string &val="val") const
 Implementation of shortID.
virtual std::string longID (const std::string &val="val") const
 Implementation of longID.

Protected Member Functions

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

Protected Attributes

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

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


Constructor & Destructor Documentation

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 
)

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

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

References TCLAP::CmdLineInterface::add().

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

References TCLAP::CmdLineInterface::add().

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


Member Function Documentation

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

References TCLAP::ValueArg< T >::_constraint, TCLAP::ValueArg< T >::_value, TCLAP::VALUE_ARG_HELPER::EXTRACT_FAILURE, TCLAP::VALUE_ARG_HELPER::EXTRACT_TOO_MANY, TCLAP::VALUE_ARG_HELPER::ValueExtractor< T >::extractValue(), and TCLAP::Arg::toString().

Referenced by TCLAP::ValueArg< T >::processArg(), and TCLAP::UnlabeledValueArg< T >::processArg().

template<class T>
bool TCLAP::ValueArg< T >::processArg ( int *  i,
std::vector< std::string > &  args 
) [virtual]

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

Implements TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 437 of file ValueArg.h.

References TCLAP::Arg::_alreadySet, TCLAP::Arg::_checkWithVisitor(), TCLAP::ValueArg< T >::_extractValue(), TCLAP::Arg::_hasBlanks(), TCLAP::Arg::_ignoreable, TCLAP::Arg::argMatches(), TCLAP::Arg::delimiter(), TCLAP::Arg::ignoreRest(), TCLAP::Arg::toString(), and TCLAP::Arg::trimFlag().

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

Implementation of getValue().

Definition at line 431 of file ValueArg.h.

References TCLAP::ValueArg< T >::_value.

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

Implementation of shortID.

Parameters:
val - value to be used.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 484 of file ValueArg.h.

References TCLAP::ValueArg< T >::_typeDesc, and TCLAP::Arg::shortID().

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

Implementation of longID.

Parameters:
val - value to be used.

Reimplemented from TCLAP::Arg.

Reimplemented in TCLAP::UnlabeledValueArg< T >.

Definition at line 493 of file ValueArg.h.

References TCLAP::ValueArg< T >::_typeDesc, and TCLAP::Arg::longID().


Member Data Documentation

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

Referenced by TCLAP::ValueArg< T >::_extractValue(), and TCLAP::ValueArg< T >::getValue().

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

Referenced by TCLAP::ValueArg< T >::longID(), TCLAP::UnlabeledValueArg< T >::longID(), TCLAP::ValueArg< T >::shortID(), and TCLAP::UnlabeledValueArg< T >::shortID().

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

A Constraint this Arg must conform to.

Definition at line 193 of file ValueArg.h.

Referenced by TCLAP::ValueArg< T >::_extractValue().


The documentation for this class was generated from the following file:
Generated on Thu Dec 14 23:01:54 2006 for tclap by  doxygen 1.5.1