LimitedCounter< StoreType, Limit > Class Template Reference

#include <limitedcounter.h>

Public Member Functions
	LimitedCounter ()
	LimitedCounter (StoreType value)
void	operator= (const LimitedCounter &rhs)
LimitedCounter &	operator++ ()
LimitedCounter	operator++ (int)
LimitedCounter &	operator+= (const uint32_t rhs)
StoreType	value () const

Private Attributes
StoreType	m_counter

Friends
LimitedCounter	operator- (const LimitedCounter lhs, const LimitedCounter &rhs)

Detailed Description

template<typename StoreType, uint32_t Limit>
class LimitedCounter< StoreType, Limit >

Definition at line 24 of file limitedcounter.h.

Constructor & Destructor Documentation

LimitedCounter() [1/2]

template<typename StoreType , uint32_t Limit>

LimitedCounter< StoreType, Limit >::LimitedCounter ( )

inline

Definition at line 27 of file limitedcounter.h.

                     :
        m_counter(0)
    {}

LimitedCounter() [2/2]

template<typename StoreType , uint32_t Limit>

LimitedCounter< StoreType, Limit >::LimitedCounter ( StoreType  value )

inline

Definition at line 31 of file limitedcounter.h.

                                    :
        m_counter(value < Limit ? value : Limit - 1)
    {}

Member Function Documentation

operator++() [1/2]

template<typename StoreType , uint32_t Limit>

LimitedCounter& LimitedCounter< StoreType, Limit >::operator++ ( )

inline

Definition at line 39 of file limitedcounter.h.

References LimitedCounter< StoreType, Limit >::m_counter.

                                 {
        m_counter++;
        if (m_counter >= Limit) {
            m_counter = 0;
        }
        return *this;
    }

operator++() [2/2]

template<typename StoreType , uint32_t Limit>

LimitedCounter LimitedCounter< StoreType, Limit >::operator++ ( int  )

inline

Definition at line 47 of file limitedcounter.h.

References LimitedCounter< StoreType, Limit >::m_counter.

                                   {
        LimitedCounter temp = *this ;
        m_counter++;
        if (m_counter >= Limit) {
            m_counter = 0;
        }
        return temp;
    }

operator+=()

template<typename StoreType , uint32_t Limit>

LimitedCounter& LimitedCounter< StoreType, Limit >::operator+= ( const uint32_t  rhs )

inline

Definition at line 56 of file limitedcounter.h.

References LimitedCounter< StoreType, Limit >::m_counter.

                                                   {
        m_counter += rhs;
        if (m_counter >= Limit) {
            m_counter -= Limit;
        }
        return *this;
    }

operator=()

template<typename StoreType , uint32_t Limit>

void LimitedCounter< StoreType, Limit >::operator= ( const LimitedCounter< StoreType, Limit > &  rhs )

inline

Definition at line 35 of file limitedcounter.h.

References LimitedCounter< StoreType, Limit >::m_counter.

                                              {
        m_counter = rhs.m_counter;
    }

value()

template<typename StoreType , uint32_t Limit>

StoreType LimitedCounter< StoreType, Limit >::value ( ) const

inline

Definition at line 64 of file limitedcounter.h.

References LimitedCounter< StoreType, Limit >::m_counter.

{ return m_counter; }

Friends And Related Function Documentation

operator-

template<typename StoreType , uint32_t Limit>

LimitedCounter operator- ( const LimitedCounter< StoreType, Limit >  lhs, const LimitedCounter< StoreType, Limit > &  rhs  )

friend

Definition at line 66 of file limitedcounter.h.

    {
        LimitedCounter result;

        if (lhs.m_counter < rhs.m_counter) {
            result.m_counter = Limit - lhs.m_counter + rhs.m_counter + 1;
        } else {
            result.m_counter = lhs.m_counter - rhs.m_counter;
        }

        return result;
    }

Member Data Documentation

m_counter

template<typename StoreType , uint32_t Limit>

StoreType LimitedCounter< StoreType, Limit >::m_counter

private

Definition at line 80 of file limitedcounter.h.

Referenced by LimitedCounter< StoreType, Limit >::operator++(), LimitedCounter< StoreType, Limit >::operator+=(), LimitedCounter< StoreType, Limit >::operator=(), and LimitedCounter< StoreType, Limit >::value().

---

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

• sdrbase/util/limitedcounter.h