tclap 1.2.2
TCLAP::ValuesConstraint< T > Class Template Reference

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

#include <ValuesConstraint.h>

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

Public Member Functions

 ValuesConstraint (std::vector< T > &allowed)
 Constructor.
 
virtual ~ValuesConstraint ()
 Virtual destructor.
 
virtual std::string description () const
 Returns a description of the Constraint.
 
virtual std::string shortID () const
 Returns the short ID for the Constraint.
 
virtual bool check (const T &value) const
 The method used to verify that the value parsed from the command line meets the constraint.
 
- Public Member Functions inherited from TCLAP::Constraint< T >
virtual ~Constraint ()
 Destructor.
 

Protected Attributes

std::vector< T > _allowed
 The list of valid values.
 
std::string _typeDesc
 The string used to describe the allowed values of this constraint.
 

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 42 of file ValuesConstraint.h.

Constructor & Destructor Documentation

◆ ValuesConstraint()

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

Constructor.

Parameters
allowed- vector of allowed values.

Definition at line 90 of file ValuesConstraint.h.

References _allowed, and _typeDesc.

◆ ~ValuesConstraint()

template<class T>
virtual TCLAP::ValuesConstraint< T >::~ValuesConstraint ( )
inlinevirtual

Virtual destructor.

Definition at line 56 of file ValuesConstraint.h.

Member Function Documentation

◆ check()

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 116 of file ValuesConstraint.h.

References _allowed.

◆ description()

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

Returns a description of the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 131 of file ValuesConstraint.h.

References _typeDesc.

◆ shortID()

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 125 of file ValuesConstraint.h.

References _typeDesc.

Member Data Documentation

◆ _allowed

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

The list of valid values.

Definition at line 80 of file ValuesConstraint.h.

Referenced by check(), and ValuesConstraint().

◆ _typeDesc

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

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

Definition at line 85 of file ValuesConstraint.h.

Referenced by description(), shortID(), and ValuesConstraint().


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