Public Member Functions | List of all members
ecl::Constraint< T > Class Template Referenceabstract

Defines the interaction between an argument and a constraint. More...

#include <constraint.hpp>

Inheritance diagram for ecl::Constraint< T >:
Inheritance graph
[legend]

Public Member Functions

virtual bool check (const T &value) const =0
 
virtual std::string description () const =0
 
virtual std::string shortID () const =0
 
virtual ~Constraint ()
 

Detailed Description

template<class T>
class ecl::Constraint< T >

Defines the interaction between an argument and a constraint.

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

Definition at line 36 of file constraint.hpp.

Constructor & Destructor Documentation

◆ ~Constraint()

template<class T >
virtual ecl::Constraint< T >::~Constraint ( )
inlinevirtual

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

Definition at line 64 of file constraint.hpp.

Member Function Documentation

◆ check()

template<class T >
virtual bool ecl::Constraint< T >::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 ecl::ValuesConstraint< T >.

◆ description()

template<class T >
virtual std::string ecl::Constraint< T >::description ( ) const
pure virtual

Returns a description of the Constraint.

Implemented in ecl::ValuesConstraint< T >.

◆ shortID()

template<class T >
virtual std::string ecl::Constraint< T >::shortID ( ) const
pure virtual

Returns the short ID for the Constraint.

Implemented in ecl::ValuesConstraint< T >.


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


ecl_command_line
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:03