Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
Gray::cRangeT< TYPE > Class Template Reference

#include <cPair.h>

Inheritance diagram for Gray::cRangeT< TYPE >:
GrayLib::cValueRange< MAP_HEIGHT_t > GrayLib::cValueRange< double > GrayLib::cValueRange< float > GrayLib::cValueRange< int > GrayLib::cValueRange< UINT32 > GrayLib::cValueRange< MAP_METERI_t > GrayLib::cValueRange< DVALUE_t > GrayLib::cValueRange< TYPE >

Public Member Functions

TYPE get_Min () const
 
TYPE get_Max () const
 
TYPE get_Avg () const
 
TYPE GetClampValue (TYPE nVal) const
 
bool IsInsideI (TYPE nVal) const
 
bool IsInsideX (TYPE nVal) const
 
TYPE get_RangeI () const
 
TYPE get_RangeX () const
 
TYPE GetLinear1 (float fOne) const
 
int GetSpinValueI (int iVal) const
 
void SetZero ()
 
void put_Min (TYPE iLo)
 
void put_Max (TYPE iHi)
 
void SetRange (TYPE iLo, TYPE iHi)
 
void NormalizeRange ()
 
void UnionValue (TYPE nVal)
 
bool IsRangeOverlapI (const THIS_t &x) const
 
void SetUnionRange (const THIS_t &x)
 

Public Attributes

TYPE m_Lo
 low range value. More...
 
TYPE m_Hi
 inclusive high side of range. int size = (hi-lo)+1, float size = hi-lo ?? weird. More...
 

Member Function Documentation

◆ get_Avg()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::get_Avg ( ) const
inline

◆ get_Max()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::get_Max ( ) const
inline

◆ get_Min()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::get_Min ( ) const
inline

◆ get_RangeI()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::get_RangeI ( ) const
inline

Typically used for inclusive int types.

◆ get_RangeX()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::get_RangeX ( ) const
inline

Typically used for exclusive float types.

◆ GetClampValue()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::GetClampValue ( TYPE  nVal) const
inline

◆ GetLinear1()

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::GetLinear1 ( float  fOne) const
inline
  • fOne = 0.0 to 1.0

◆ GetSpinValueI()

template<typename TYPE >
int Gray::cRangeT< TYPE >::GetSpinValueI ( int  iVal) const
inline
Returns
a modulus of the range.

◆ IsInsideI()

template<typename TYPE >
bool Gray::cRangeT< TYPE >::IsInsideI ( TYPE  nVal) const
inline

Is the index in the range? inclusive.

◆ IsInsideX()

template<typename TYPE >
bool Gray::cRangeT< TYPE >::IsInsideX ( TYPE  nVal) const
inline

Is the index in the range? Non inclusive.

Note
if size 0 then this is never true !

◆ IsRangeOverlapI()

template<typename TYPE >
bool Gray::cRangeT< TYPE >::IsRangeOverlapI ( const THIS_t x) const
inline

◆ NormalizeRange()

template<typename TYPE >
void Gray::cRangeT< TYPE >::NormalizeRange ( )
inline

◆ put_Max()

template<typename TYPE >
void Gray::cRangeT< TYPE >::put_Max ( TYPE  iHi)
inline

◆ put_Min()

template<typename TYPE >
void Gray::cRangeT< TYPE >::put_Min ( TYPE  iLo)
inline

◆ SetRange()

template<typename TYPE >
void Gray::cRangeT< TYPE >::SetRange ( TYPE  iLo,
TYPE  iHi 
)
inline

May not be normalized ?

◆ SetUnionRange()

template<typename TYPE >
void Gray::cRangeT< TYPE >::SetUnionRange ( const THIS_t x)
inline

◆ SetZero()

template<typename TYPE >
void Gray::cRangeT< TYPE >::SetZero ( )
inline

◆ UnionValue()

template<typename TYPE >
void Gray::cRangeT< TYPE >::UnionValue ( TYPE  nVal)
inline

Expand the range to include this value. Normalized

Member Data Documentation

◆ m_Hi

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::m_Hi

inclusive high side of range. int size = (hi-lo)+1, float size = hi-lo ?? weird.

◆ m_Lo

template<typename TYPE >
TYPE Gray::cRangeT< TYPE >::m_Lo

low range value.


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