FIFO< _T > Class Template Reference

#include <FIFO.h>

Inheritance diagram for FIFO< _T >:

Public Member Functions
	FIFO (unsigned int depth=0)
	FIFO (const FIFO &f)
bool	push (const _T &x)
_T	pop ()
_T &	front ()
_T &	back ()
const _T &	front () const
const _T &	back () const
bool	empty () const
unsigned int	maxSize () const
unsigned int	size () const
void	clear ()
void	printOn (std::ostream &out=cout)
bool	full () const
bool	avail () const

Detailed Description

template<class _T>
class FIFO< _T >

Definition at line 20 of file FIFO.h.

Constructor & Destructor Documentation

FIFO() [1/2]

template<class _T >

FIFO< _T >::FIFO ( unsigned int depth = 0 )

inline

Definition at line 23 of file FIFO.h.

    : vector<_T>(), m_depth(depth)    
    {
    if (depth > 0)  reserve ( depth );
 
    // if the depth of the fifo is fixed, then reserve enough space to contain it entirely
    // FIFO operates in two modes: one for a fixed depth,
    // and another for a non-fixed depth (unlimited)
    }

FIFO() [2/2]

template<class _T >

FIFO< _T >::FIFO ( const FIFO< _T > & f )

inline

Definition at line 33 of file FIFO.h.

    : vector<_T>(f), m_depth(f.m_depth)
    {
    }

Member Function Documentation

avail()

template<class _T >

bool FIFO< _T >::avail ( ) const

inline

Definition at line 103 of file FIFO.h.

{ return size() < m_depth; }

back() [1/2]

template<class _T >

_T & FIFO< _T >::back ( )

inline

Definition at line 65 of file FIFO.h.

{ return vector<_T>::back(); }

back() [2/2]

template<class _T >

const _T & FIFO< _T >::back ( ) const

inline

Definition at line 68 of file FIFO.h.

{ return vector<_T>::back(); }

clear()

template<class _T >

void FIFO< _T >::clear ( )

inline

Definition at line 84 of file FIFO.h.

      {
     vector<_T>::clear();
      }

empty()

template<class _T >

bool FIFO< _T >::empty ( ) const

inline

Definition at line 70 of file FIFO.h.

{ return (size() == 0); }

front() [1/2]

template<class _T >

_T & FIFO< _T >::front ( )

inline

Definition at line 64 of file FIFO.h.

{ return vector<_T>::front(); }

front() [2/2]

template<class _T >

const _T & FIFO< _T >::front ( ) const

inline

Definition at line 67 of file FIFO.h.

{ return vector<_T>::front(); }

full()

template<class _T >

bool FIFO< _T >::full ( ) const

inline

Definition at line 101 of file FIFO.h.

{ return size() == m_depth; }

maxSize()

template<class _T >

unsigned int FIFO< _T >::maxSize ( ) const

inline

Definition at line 73 of file FIFO.h.

      {
      return m_depth;
      }

pop()

template<class _T >

_T FIFO< _T >::pop ( )

inline

Definition at line 53 of file FIFO.h.

      {
      assert(size()>0);
      _T    value (*begin());
      erase(begin());
      
      // limited depth mode
      
      return value;
      }

printOn()

template<class _T >

void FIFO< _T >::printOn ( std::ostream & out = cout )

inline

Definition at line 90 of file FIFO.h.

      {
      short i = 1;
      for (vector<_T>::reverse_iterator it = rbegin(); it != rend(); ++it) {
          out << (*it)();
          if ((i % 8) == 0) out << "\n";
          else  out << "\t";
          i++;
      }
      }

push()

template<class _T >

bool FIFO< _T >::push ( const _T & x )

inline

Definition at line 41 of file FIFO.h.

      {
      if ((m_depth != 0) && (size() >= m_depth))    return false;
 
      push_back( x );
 
      return true;
      }

size()

template<class _T >

unsigned int FIFO< _T >::size ( ) const

inline

Definition at line 79 of file FIFO.h.

      {
      return vector<_T>::size();
      }

Referenced by FIFO< _T >::avail(), FIFO< _T >::empty(), FIFO< _T >::full(), FIFO< _T >::pop(), and FIFO< _T >::push().

---

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

• FIFO.h