#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

	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 Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

Constructor & Destructor Documentation

◆ FIFO() [1/4]

template<class _T >

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

inline

Definition at line 23 of file Calibration/facilities/facilities-00-00-04/facilities/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/4]

template<class _T >

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

inline

Definition at line 33 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ FIFO() [3/4]

template<class _T >

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

inline

Definition at line 23 of file InstallArea/include/facilities/facilities/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() [4/4]

template<class _T >

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

inline

Definition at line 33 of file InstallArea/include/facilities/facilities/FIFO.h.

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

Member Function Documentation

◆ avail() [1/2]

template<class _T >

bool FIFO< _T >::avail ( ) const

inline

Definition at line 103 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

103{ return size() < m_depth; }

FIFO::size

unsigned int size() const

Definition: Calibration/facilities/facilities-00-00-04/facilities/FIFO.h:79

◆ avail() [2/2]

template<class _T >

bool FIFO< _T >::avail ( ) const

inline

Definition at line 103 of file InstallArea/include/facilities/facilities/FIFO.h.

103{ return size() < m_depth; }

◆ back() [1/4]

template<class _T >

_T & FIFO< _T >::back ( )

inline

Definition at line 65 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ back() [2/4]

template<class _T >

_T & FIFO< _T >::back ( )

inline

Definition at line 65 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ back() [3/4]

template<class _T >

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

inline

Definition at line 68 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ back() [4/4]

template<class _T >

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

inline

Definition at line 68 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ clear() [1/2]

template<class _T >

void FIFO< _T >::clear ( )

inline

Definition at line 84 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ clear() [2/2]

template<class _T >

void FIFO< _T >::clear ( )

inline

Definition at line 84 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ empty() [1/2]

template<class _T >

bool FIFO< _T >::empty ( ) const

inline

Definition at line 70 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ empty() [2/2]

template<class _T >

bool FIFO< _T >::empty ( ) const

inline

Definition at line 70 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ front() [1/4]

template<class _T >

_T & FIFO< _T >::front ( )

inline

Definition at line 64 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ front() [2/4]

template<class _T >

_T & FIFO< _T >::front ( )

inline

Definition at line 64 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ front() [3/4]

template<class _T >

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

inline

Definition at line 67 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ front() [4/4]

template<class _T >

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

inline

Definition at line 67 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ full() [1/2]

template<class _T >

bool FIFO< _T >::full ( ) const

inline

Definition at line 101 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

101{ return size() == m_depth; }

◆ full() [2/2]

template<class _T >

bool FIFO< _T >::full ( ) const

inline

Definition at line 101 of file InstallArea/include/facilities/facilities/FIFO.h.

101{ return size() == m_depth; }

◆ maxSize() [1/2]

template<class _T >

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

inline

Definition at line 73 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

      {
      return m_depth;
      }

◆ maxSize() [2/2]

template<class _T >

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

inline

Definition at line 73 of file InstallArea/include/facilities/facilities/FIFO.h.

      {
      return m_depth;
      }

◆ pop() [1/2]

template<class _T >

_T FIFO< _T >::pop ( )

inline

Definition at line 53 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ pop() [2/2]

template<class _T >

_T FIFO< _T >::pop ( )

inline

Definition at line 53 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ printOn() [1/2]

template<class _T >

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

inline

Definition at line 90 of file Calibration/facilities/facilities-00-00-04/facilities/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++;
      }
      }

◆ printOn() [2/2]

template<class _T >

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

inline

Definition at line 90 of file InstallArea/include/facilities/facilities/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() [1/2]

template<class _T >

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

inline

Definition at line 41 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

◆ push() [2/2]

template<class _T >

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

inline

Definition at line 41 of file InstallArea/include/facilities/facilities/FIFO.h.

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

◆ size() [1/2]

template<class _T >

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

inline

Definition at line 79 of file Calibration/facilities/facilities-00-00-04/facilities/FIFO.h.

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

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

◆ size() [2/2]

template<class _T >

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

inline

Definition at line 79 of file InstallArea/include/facilities/facilities/FIFO.h.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FIFO() [1/4]

◆ FIFO() [2/4]

◆ FIFO() [3/4]

◆ FIFO() [4/4]

Member Function Documentation

◆ avail() [1/2]

◆ avail() [2/2]

◆ back() [1/4]

◆ back() [2/4]

◆ back() [3/4]

◆ back() [4/4]

◆ clear() [1/2]

◆ clear() [2/2]

◆ empty() [1/2]

◆ empty() [2/2]

◆ front() [1/4]

◆ front() [2/4]

◆ front() [3/4]

◆ front() [4/4]

◆ full() [1/2]

◆ full() [2/2]

◆ maxSize() [1/2]

◆ maxSize() [2/2]

◆ pop() [1/2]

◆ pop() [2/2]

◆ printOn() [1/2]

◆ printOn() [2/2]

◆ push() [1/2]

◆ push() [2/2]

◆ size() [1/2]

◆ size() [2/2]