CircularCounter< T > Class Template Reference

#include <TAPsCircularCounter.hpp>

Inheritance diagram for CircularCounter< T >:

[legend]

Collaboration diagram for CircularCounter< T >:

[legend]

List of all members.

Public Member Functions
	CircularCounter (T v1, T v2, T v3)
	CircularCounter ()
	Default Ctor.
void	CountDown (T v)
void	CountDown ()
T	CountDownAndReturnTheCountValue (T v)
T	CountDownAndReturnTheCountValue ()
void	CountUp (T v)
void	CountUp ()
T	CountUpAndReturnTheCountValue (T v)
T	CountUpAndReturnTheCountValue ()
T	GetValueCurrent () const
T	GetValueHighest () const
T	GetValueLowest () const
void	SetValueCurrent (T v)
void	SetValueHighest (T v)
void	SetValueLowest (T v)
virtual	~CircularCounter ()
	Destructor.
Protected Member Functions
void	CheckCountDown ()
void	CheckCountUp ()
Protected Attributes
T	m_tCurrent
T	m_tHighest
T	m_tLowest
Friends
std::ostream &	operator<< (std::ostream &output, CircularCounter< T > const &ctr)

---

Detailed Description

template<typename T>
class CircularCounter< T >

An interger circular counter with setable low and high limit value. The counter can be count up or count down with loop when it is over (below) the high (low) limit value.

Definition at line 25 of file TAPsCircularCounter.hpp.

---

Constructor & Destructor Documentation

template<typename T>

CircularCounter< T >::CircularCounter

(

)

[inline]

Default Ctor.

Definition at line 45 of file TAPsCircularCounter.hpp.

                       : m_tCurrent(0)
    {
        if ( typeid(T) == typeid(unsigned char) ) {
            m_tLowest   = 0;
            m_tHighest  = static_cast<unsigned char>( UCHAR_MAX );
        }
        else if ( typeid(T) == typeid(char) ) {
            m_tLowest   = static_cast<char>( CHAR_MIN );
            m_tHighest  = static_cast<char>( CHAR_MAX );
        }
        else if ( typeid(T) == typeid(unsigned short) ) {
            m_tLowest   = 0;
            m_tHighest  = static_cast<unsigned short>( USHRT_MAX );
        }
        else if ( typeid(T) == typeid(short) ) {
            m_tLowest   = static_cast<short>( SHRT_MIN );
            m_tHighest  = static_cast<short>( SHRT_MAX );
        }
        else if ( typeid(T) == typeid(unsigned int) ) {
            m_tLowest   = 0;
            m_tHighest  = static_cast<unsigned int>( UINT_MAX );
        }
        else if ( typeid(T) == typeid(int) ) {
            m_tLowest   = static_cast<int>( INT_MIN );
            m_tHighest  = static_cast<int>( INT_MAX );
        }
        else if ( typeid(T) == typeid(unsigned long) ) {
            m_tLowest   = 0;
            m_tHighest  = static_cast<unsigned long>( ULONG_MAX );
        }
        else if ( typeid(T) == typeid(long) ) {
            m_tLowest   = static_cast<long>( LONG_MIN );
            m_tHighest  = static_cast<long>( LONG_MAX );
        }
    }

template<typename T>

CircularCounter< T >::CircularCounter	(	T	v1,
		T	v2,
		T	v3
	)			[inline]

The highest, current, and lowest value can be passed in any order.

Definition at line 84 of file TAPsCircularCounter.hpp.

    {
        if ( v1 >= v2 ) {
            if ( v1 >= v3 ) {
                m_tHighest = v1;
                if ( v2 >= v3 ) {
                    m_tCurrent = v2;
                    m_tLowest  = v3;
                }
                else {
                    m_tCurrent = v3;
                    m_tLowest  = v2;
                }
            }
            else {
                m_tHighest = v3;
                m_tCurrent = v1;
                m_tLowest  = v2;
            }
        }
        else {
            if ( v2 >= v3 ) {
                m_tHighest = v2;
                if ( v1 >= v3 ) {
                    m_tCurrent = v1;
                    m_tLowest  = v3;
                }
                else {
                    m_tCurrent = v3;
                    m_tLowe st = v1;
                }
            }
            else {
                m_tHighest = v3;
                m_tCurrent = v2;
                m_tLowe st = v1;
            }
        }
    }

template<typename T>

virtual CircularCounter< T >::~CircularCounter

(

)

[inline, virtual]

Destructor.

Definition at line 125 of file TAPsCircularCounter.hpp.

{};

---

Member Function Documentation

template<typename T>

void CircularCounter< T >::CheckCountDown

(

)

[inline, protected]

Definition at line 203 of file TAPsCircularCounter.hpp.

    { if ( m_tCurrent < m_tLowest )     m_tCurrent = m_tHighest; }

template<typename T>

void CircularCounter< T >::CheckCountUp

(

)

[inline, protected]

Definition at line 201 of file TAPsCircularCounter.hpp.

    { if ( m_tCurrent > m_tHighest )    m_tCurrent = m_tLowest; }

template<typename T>

void CircularCounter< T >::CountDown

(

T

v

)

[inline]

Definition at line 167 of file TAPsCircularCounter.hpp.

    {
        m_tCurrent -= v;
        CheckCountDown();
    }

template<typename T>

void CircularCounter< T >::CountDown

(

)

[inline]

Definition at line 162 of file TAPsCircularCounter.hpp.

    {
        --m_tCurrent;
        CheckCountDown();
    }

template<typename T>

T CircularCounter< T >::CountDownAndReturnTheCountValue

(

T

v

)

[inline]

Definition at line 191 of file TAPsCircularCounter.hpp.

    {
        m_tCurrent -= v;
        CheckCountDown();
        return m_tCurrent;
    }

template<typename T>

T CircularCounter< T >::CountDownAndReturnTheCountValue

(

)

[inline]

Definition at line 185 of file TAPsCircularCounter.hpp.

    {
        --m_tCurrent;
        CheckCountDown();
        return m_tCurrent;
    }

template<typename T>

void CircularCounter< T >::CountUp

(

T

v

)

[inline]

Definition at line 157 of file TAPsCircularCounter.hpp.

    {
        m_tCurrent += v;
        CheckCountUp();
    }

template<typename T>

void CircularCounter< T >::CountUp

(

)

[inline]

Definition at line 152 of file TAPsCircularCounter.hpp.

    {
        ++m_tCurrent;
        CheckCountUp();
    }

template<typename T>

T CircularCounter< T >::CountUpAndReturnTheCountValue

(

T

v

)

[inline]

Definition at line 179 of file TAPsCircularCounter.hpp.

    {
        m_tCurrent += v;
        CheckCountUp();
        return m_tCurrent;
    }

template<typename T>

T CircularCounter< T >::CountUpAndReturnTheCountValue

(

)

[inline]

Definition at line 173 of file TAPsCircularCounter.hpp.

    {
        ++m_tCurrent;
        CheckCountUp();
        return m_tCurrent;
    }

template<typename T>

T CircularCounter< T >::GetValueCurrent

(

)

const [inline]

Definition at line 130 of file TAPsCircularCounter.hpp.

{ return m_tCurrent; }

template<typename T>

T CircularCounter< T >::GetValueHighest

(

)

const [inline]

Definition at line 131 of file TAPsCircularCounter.hpp.

{ return m_tHighest; }

template<typename T>

T CircularCounter< T >::GetValueLowest

(

)

const [inline]

Definition at line 129 of file TAPsCircularCounter.hpp.

{ return m_tLowest; }

template<typename T>

void CircularCounter< T >::SetValueCurrent

(

T

v

)

[inline]

Definition at line 137 of file TAPsCircularCounter.hpp.

    {
        if      ( v > m_tHighest )  m_tCurrent = m_tHighest;
        else if ( v < m_tLowest )   m_tCurrent = m_tLowest;
        else                        m_tCurrent = v;
    }

template<typename T>

void CircularCounter< T >::SetValueHighest

(

T

v

)

[inline]

Definition at line 143 of file TAPsCircularCounter.hpp.

    {
        if ( m_tHighest > m_tLowest )   m_tHighest = v;
        if ( m_tHighest < m_tCurrent )  m_tCurrent = v;
    }

template<typename T>

void CircularCounter< T >::SetValueLowest

(

T

v

)

[inline]

Definition at line 132 of file TAPsCircularCounter.hpp.

    {
        if ( m_tLowest < m_tHighest )   m_tLowest  = v;
        if ( m_tLowest > m_tCurrent )   m_tCurrent = v;
    }

---

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<<	(	std::ostream &	output,
		CircularCounter< T > const &	ctr
	)			[friend]

Definition at line 31 of file TAPsCircularCounter.hpp.

    {
        output  << "CircularCounter<" << typeid(T).name() << ">"
                <<  " Highest Value (" << ctr.m_tHighest
                << ") Current Value (" << ctr.m_tCurrent
                << ") Lowest Value ("  << ctr.m_tLowest;
                << ")\n";
        return output;
    }

---

Member Data Documentation

template<typename T>

T CircularCounter< T >::m_tCurrent [protected]

Definition at line 208 of file TAPsCircularCounter.hpp.

template<typename T>

T CircularCounter< T >::m_tHighest [protected]

Definition at line 209 of file TAPsCircularCounter.hpp.

template<typename T>

T CircularCounter< T >::m_tLowest [protected]

Definition at line 207 of file TAPsCircularCounter.hpp.

---

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

• G:/spunak_xp/Works/TAPs/Include/TAPs/Gadgets/TAPsCircularCounter.hpp