tclap  1.2.0
Public Member Functions
TCLAP::Constraint Class Reference

The interface that defines the interaction between the Arg and Constraint. More...

#include <Constraint.h>

Inheritance diagram for TCLAP::Constraint:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual std::string description () const =0
 Returns a description of the Constraint.
virtual std::string shortID () const =0
 Returns the short ID for the Constraint.
virtual bool check (const T &value) const =0
 The method used to verify that the value parsed from the command line meets the constraint.
virtual ~Constraint ()
 Destructor.

Detailed Description

The interface that defines the interaction between the Arg and Constraint.


Constructor & Destructor Documentation

virtual TCLAP::Constraint::~Constraint ( ) [inline, virtual]

Destructor.

Silences warnings about Constraint being a base class with virtual functions but without a virtual destructor.

Definition at line 64 of file Constraint.h.


Member Function Documentation

virtual bool TCLAP::Constraint::check ( const T &  value) const [pure 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.

Implemented in TCLAP::ValuesConstraint.

virtual std::string TCLAP::Constraint::description ( ) const [pure virtual]

Returns a description of the Constraint.

Implemented in TCLAP::ValuesConstraint.

virtual std::string TCLAP::Constraint::shortID ( ) const [pure virtual]

Returns the short ID for the Constraint.

Implemented in TCLAP::ValuesConstraint.


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