LSSTApplications  8.0.0.0+107,8.0.0.1+13,9.1+18,9.2,master-g084aeec0a4,master-g0aced2eed8+6,master-g15627eb03c,master-g28afc54ef9,master-g3391ba5ea0,master-g3d0fb8ae5f,master-g4432ae2e89+36,master-g5c3c32f3ec+17,master-g60f1e072bb+1,master-g6a3ac32d1b,master-g76a88a4307+1,master-g7bce1f4e06+57,master-g8ff4092549+31,master-g98e65bf68e,master-ga6b77976b1+53,master-gae20e2b580+3,master-gb584cd3397+53,master-gc5448b162b+1,master-gc54cf9771d,master-gc69578ece6+1,master-gcbf758c456+22,master-gcec1da163f+63,master-gcf15f11bcc,master-gd167108223,master-gf44c96c709
LSSTDataManagementBasePackage
Public Member Functions | Private Member Functions | Private Attributes | List of all members
lsst::ap::Fifo< NumEntries > Class Template Reference

A First In, First Out (FIFO) queue of fixed capacity. More...

#include <Fifo.h>

Inheritance diagram for lsst::ap::Fifo< NumEntries >:

Public Member Functions

 Fifo ()
 Creates an empty Fifo. More...
 
void clear ()
 Empties the Fifo. More...
 
bool empty () const
 Returns true if the Fifo is empty. More...
 
bool full () const
 Returns true if the Fifo is full. More...
 
void enqueue (boost::int64_t const elt)
 
boost::int64_t dequeue ()
 

Private Member Functions

 BOOST_STATIC_ASSERT (NumEntries > 0 &&(NumEntries &(NumEntries-1))==0)
 

Private Attributes

boost::int64_t _buffer [NumEntries]
 
int _size
 
int _back
 
int _front
 

Detailed Description

template<int NumEntries>
class lsst::ap::Fifo< NumEntries >

A First In, First Out (FIFO) queue of fixed capacity.

Definition at line 48 of file Fifo.h.

Constructor & Destructor Documentation

template<int NumEntries>
lsst::ap::Fifo< NumEntries >::Fifo ( )
inline

Creates an empty Fifo.

Definition at line 56 of file Fifo.h.

56 { clear(); }
lsst::ap::Fifo::clear
void clear()
Empties the Fifo.
Definition: Fifo.h:59

Member Function Documentation

template<int NumEntries>
lsst::ap::Fifo< NumEntries >::BOOST_STATIC_ASSERT ( NumEntries  ,
0 &&  NumEntries &(NumEntries-1) = =0 
)
private
template<int NumEntries>
void lsst::ap::Fifo< NumEntries >::clear ( )
inline

Empties the Fifo.

Definition at line 59 of file Fifo.h.

59  {
60  _size = 0;
61  _back = 0;
62  _front = 0;
63  }
lsst::ap::Fifo::_size
int _size
Definition: Fifo.h:113
lsst::ap::Fifo::_front
int _front
Definition: Fifo.h:115
lsst::ap::Fifo::_back
int _back
Definition: Fifo.h:114
template<int NumEntries>
boost::int64_t lsst::ap::Fifo< NumEntries >::dequeue ( )
inline

Removes the least recently inserted integer from the Fifo.

Exceptions
lsst::pex::exceptions::LengthErrorThrown if the Fifo is empty.

Definition at line 97 of file Fifo.h.

97  {
98  int sz = _size;
99  if (sz == 0) {
100  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
101  "unable to remove element from empty FIFO");
102  }
103  int i = _front;
104  boost::int64_t elt = _buffer[i];
105  _front = (i + 1) & (NumEntries - 1);
106  _size = sz - 1;
107  return elt;
108  }
lsst::ap::Fifo::_size
int _size
Definition: Fifo.h:113
lsst::ap::Fifo::_front
int _front
Definition: Fifo.h:115
lsst::ap::Fifo::_buffer
boost::int64_t _buffer[NumEntries]
Definition: Fifo.h:112
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
template<int NumEntries>
bool lsst::ap::Fifo< NumEntries >::empty ( ) const
inline

Returns true if the Fifo is empty.

Definition at line 66 of file Fifo.h.

66  {
67  return _size == 0;
68  }
lsst::ap::Fifo::_size
int _size
Definition: Fifo.h:113
template<int NumEntries>
void lsst::ap::Fifo< NumEntries >::enqueue ( boost::int64_t const  elt)
inline

Inserts the given integer into the Fifo.

Exceptions
lsst::pex::exceptions::LengthErrorThrown if the Fifo is full.

Definition at line 80 of file Fifo.h.

80  {
81  int sz = _size;
82  if (sz == NumEntries) {
83  throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
84  "unable to insert element into full FIFO");
85  }
86  int i = _back;
87  _buffer[i] = elt;
88  _back = (i + 1) & (NumEntries - 1);
89  _size = sz + 1;
90  }
lsst::ap::Fifo::_size
int _size
Definition: Fifo.h:113
lsst::ap::Fifo::_buffer
boost::int64_t _buffer[NumEntries]
Definition: Fifo.h:112
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
lsst::ap::Fifo::_back
int _back
Definition: Fifo.h:114
template<int NumEntries>
bool lsst::ap::Fifo< NumEntries >::full ( ) const
inline

Returns true if the Fifo is full.

Definition at line 71 of file Fifo.h.

71  {
72  return _size == NumEntries;
73  }
lsst::ap::Fifo::_size
int _size
Definition: Fifo.h:113

Member Data Documentation

template<int NumEntries>
int lsst::ap::Fifo< NumEntries >::_back
private

Definition at line 114 of file Fifo.h.

template<int NumEntries>
boost::int64_t lsst::ap::Fifo< NumEntries >::_buffer[NumEntries]
private

Definition at line 112 of file Fifo.h.

template<int NumEntries>
int lsst::ap::Fifo< NumEntries >::_front
private

Definition at line 115 of file Fifo.h.

template<int NumEntries>
int lsst::ap::Fifo< NumEntries >::_size
private

Definition at line 113 of file Fifo.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 8 2014 18:37:11 for LSSTApplications by   doxygen 1.8.5