Chi-Tech
chi_data_types::AllowableRange Class Referenceabstract

#include <allowable_range.h>

Inheritance diagram for chi_data_types::AllowableRange:
chi_data_types::AllowableRangeHighLimit chi_data_types::AllowableRangeList chi_data_types::AllowableRangeLowHighLimit chi_data_types::AllowableRangeLowLimit

Public Member Functions

template<typename T >
bool IsAllowable (const T &value)
 
template<typename T >
std::string OutOfRangeString (const std::string &scope, const T &value) const
 
std::string PrintRange ()
 
virtual ~AllowableRange ()=default
 

Protected Member Functions

virtual bool ChildIsAllowable (Varying value) const =0
 
virtual std::string AllowableRangeStr () const =0
 

Detailed Description

Base class for an allowable range.

Definition at line 15 of file allowable_range.h.

Constructor & Destructor Documentation

◆ ~AllowableRange()

virtual chi_data_types::AllowableRange::~AllowableRange ( )
virtualdefault

Member Function Documentation

◆ AllowableRangeStr()

virtual std::string chi_data_types::AllowableRange::AllowableRangeStr ( ) const
protectedpure virtual

◆ ChildIsAllowable()

virtual bool chi_data_types::AllowableRange::ChildIsAllowable ( Varying  value) const
protectedpure virtual

◆ IsAllowable()

template<typename T >
bool chi_data_types::AllowableRange::IsAllowable ( const T &  value)
inline

Returns true is the value is within the allowable range.

Definition at line 24 of file allowable_range.h.

◆ OutOfRangeString()

template<typename T >
std::string chi_data_types::AllowableRange::OutOfRangeString ( const std::string &  scope,
const T &  value 
) const
inline

Provides a formatted string of the message to display if a value is out of range.

Definition at line 32 of file allowable_range.h.

◆ PrintRange()

std::string chi_data_types::AllowableRange::PrintRange ( )
inline

Prints the allowable constraints to a string.

Definition at line 46 of file allowable_range.h.


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