BASIS  version 1.2.3 (revision 2104)
Public Member Functions | Protected Attributes
TCLAP::ValuesConstraint< T > Class Template Reference

#include <ValuesConstraint.h>

+ Inheritance diagram for TCLAP::ValuesConstraint< T >:
+ Collaboration diagram for TCLAP::ValuesConstraint< T >:

List of all members.

Public Member Functions

virtual bool check (const T &value) const
virtual std::string description () const
virtual std::string shortID () const
 ValuesConstraint (std::vector< T > &allowed)
virtual ~ValuesConstraint ()

Protected Attributes

std::vector< T > _allowed
std::string _typeDesc

Detailed Description

template<class T>
class TCLAP::ValuesConstraint< T >

A Constraint that constrains the Arg to only those values specified in the constraint.

Definition at line 47 of file ValuesConstraint.h.


Constructor & Destructor Documentation

template<class T >
TCLAP::ValuesConstraint< T >::ValuesConstraint ( std::vector< T > &  allowed)

Constructor.

Parameters:
allowed- vector of allowed values.

Definition at line 95 of file ValuesConstraint.h.

template<class T >
virtual TCLAP::ValuesConstraint< T >::~ValuesConstraint ( ) [inline, virtual]

Virtual destructor.

Definition at line 61 of file ValuesConstraint.h.


Member Function Documentation

template<class T >
bool TCLAP::ValuesConstraint< T >::check ( const T &  value) const [virtual]

The method used to verify that the value parsed from the command line meets the constraint.

Parameters:
value- The value that will be checked.

Implements TCLAP::Constraint< T >.

Definition at line 121 of file ValuesConstraint.h.

template<class T >
std::string TCLAP::ValuesConstraint< T >::description ( ) const [virtual]

Returns a description of the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 136 of file ValuesConstraint.h.

template<class T >
std::string TCLAP::ValuesConstraint< T >::shortID ( ) const [virtual]

Returns the short ID for the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 130 of file ValuesConstraint.h.


Member Data Documentation

template<class T >
std::vector<T> TCLAP::ValuesConstraint< T >::_allowed [protected]

The list of valid values.

Definition at line 85 of file ValuesConstraint.h.

template<class T >
std::string TCLAP::ValuesConstraint< T >::_typeDesc [protected]

The string used to describe the allowed values of this constraint.

Definition at line 90 of file ValuesConstraint.h.


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