tclap 1.6.0
Public Member Functions | Protected Attributes | List of all members
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 >:
Inheritance graph
[legend]
Collaboration diagram for TCLAP::ValuesConstraint< T >:
Collaboration graph
[legend]

Public Member Functions

 ValuesConstraint (const std::vector< T > &allowed)
 Constructor.
 
 ~ValuesConstraint () override=default
 Virtual destructor.
 
std::string description () const override
 Returns a description of the Constraint.
 
std::string shortID () const override
 Returns the short ID for the Constraint.
 
bool check (const T &value) const override
 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 ()=default
 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from TCLAP::Constraint< T >
static std::string shortID (const Constraint< T > *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 51 of file ValuesConstraint.h.

Constructor & Destructor Documentation

◆ ValuesConstraint()

template<class T >
requires detail::OStreamInsertable<T>
TCLAP::ValuesConstraint< T >::ValuesConstraint ( const std::vector< T > &  allowed)
explicit

Constructor.

Parameters
allowed- vector of allowed values.

Definition at line 95 of file ValuesConstraint.h.

◆ ~ValuesConstraint()

template<class T >
TCLAP::ValuesConstraint< T >::~ValuesConstraint ( )
overridedefault

Virtual destructor.

Member Function Documentation

◆ check()

template<class T >
bool TCLAP::ValuesConstraint< T >::check ( const T &  value) const
overridevirtual

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

◆ description()

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

Returns a description of the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 120 of file ValuesConstraint.h.

◆ shortID()

template<class T >
std::string TCLAP::ValuesConstraint< T >::shortID ( ) const
overridevirtual

Returns the short ID for the Constraint.

Implements TCLAP::Constraint< T >.

Definition at line 115 of file ValuesConstraint.h.

Member Data Documentation

◆ _allowed

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

The list of valid values.

Definition at line 86 of file ValuesConstraint.h.

◆ _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 91 of file ValuesConstraint.h.


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