trklet::CircularBuffer< T > Class Template Reference

#include <CircularBuffer.h>

Public Member Functions
bool	almostfull () const
	CircularBuffer (unsigned int nbits)
bool	empty () const
bool	full () const
bool	nearfull () const
const T &	peek () const
const T &	read ()
void	reset ()
unsigned int	rptr () const
void	store (T element)
unsigned int	wptr () const
	~CircularBuffer ()=default

Private Attributes
std::vector< T >	buffer_
unsigned int	rptr_
unsigned int	size_
unsigned int	wptr_

Detailed Description

template<class T>
class trklet::CircularBuffer< T >

Definition at line 10 of file CircularBuffer.h.

Constructor & Destructor Documentation

CircularBuffer()

template<class T>

trklet::CircularBuffer< T >::CircularBuffer ( unsigned int  nbits )

inline

Definition at line 12 of file CircularBuffer.h.

                                       {
      size_ = 1 << nbits;
      buffer_.resize(size_);
      reset();
    }

~CircularBuffer()

template<class T>

trklet::CircularBuffer< T >::~CircularBuffer ( )

default

Member Function Documentation

almostfull()

template<class T>

bool trklet::CircularBuffer< T >::almostfull ( ) const

inline

Definition at line 29 of file CircularBuffer.h.

{ return (((wptr_ + 1) % size_) == rptr_) || (((wptr_ + 2) % size_) == rptr_); }

empty()

template<class T>

bool trklet::CircularBuffer< T >::empty ( void  ) const

inline

Definition at line 37 of file CircularBuffer.h.

Referenced by trklet::TrackletProcessor::execute(), trklet::CircularBuffer< trklet::ProjectionTemp >::peek(), and trklet::CircularBuffer< trklet::ProjectionTemp >::read().

{ return wptr_ == rptr_; }

full()

template<class T>

bool trklet::CircularBuffer< T >::full ( ) const

inline

Definition at line 26 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::store().

{ return ((wptr_ + 1) % size_) == rptr_; }

nearfull()

template<class T>

bool trklet::CircularBuffer< T >::nearfull ( ) const

inline

Definition at line 32 of file CircularBuffer.h.

Referenced by trklet::TrackletProcessor::execute().

                          {
      return (((wptr_ + 1) % size_) == rptr_) || (((wptr_ + 2) % size_) == rptr_) || (((wptr_ + 3) % size_) == rptr_);
    }

peek()

template<class T>

const T& trklet::CircularBuffer< T >::peek ( ) const

inline

Definition at line 46 of file CircularBuffer.h.

                          {
      assert(!empty());
      return buffer_[rptr_];
    }

read()

template<class T>

const T& trklet::CircularBuffer< T >::read ( )

inline

Definition at line 39 of file CircularBuffer.h.

Referenced by edmIntegrityCheck.PublishToFileSystem::get().

                    {
      assert(!empty());
      unsigned int oldrptr = rptr_;
      rptr_ = (rptr_ + 1) % size_;
      return buffer_[oldrptr];
    }

reset()

template<class T>

void trklet::CircularBuffer< T >::reset ( void  )

inline

Definition at line 20 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::CircularBuffer().

                 {
      rptr_ = 0;
      wptr_ = 0;
    }

rptr()

template<class T>

unsigned int trklet::CircularBuffer< T >::rptr ( ) const

inline

Definition at line 59 of file CircularBuffer.h.

Referenced by trklet::TrackletProcessor::execute().

{ return rptr_; }

store()

template<class T>

void trklet::CircularBuffer< T >::store ( T  element )

inline

Definition at line 51 of file CircularBuffer.h.

Referenced by trklet::TrackletProcessor::execute().

                          {
      assert(!full());
      buffer_[wptr_++] = element;
      wptr_ = wptr_ % size_;
      assert(wptr_ != rptr_);
    }

wptr()

template<class T>

unsigned int trklet::CircularBuffer< T >::wptr ( ) const

inline

Definition at line 60 of file CircularBuffer.h.

Referenced by trklet::TrackletProcessor::execute().

{ return wptr_; }

Member Data Documentation

buffer_

template<class T>

std::vector<T> trklet::CircularBuffer< T >::buffer_

private

Definition at line 63 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::CircularBuffer(), trklet::CircularBuffer< trklet::ProjectionTemp >::peek(), trklet::CircularBuffer< trklet::ProjectionTemp >::read(), and trklet::CircularBuffer< trklet::ProjectionTemp >::store().

rptr_

template<class T>

unsigned int trklet::CircularBuffer< T >::rptr_

private

Definition at line 69 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::almostfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::empty(), trklet::CircularBuffer< trklet::ProjectionTemp >::full(), trklet::CircularBuffer< trklet::ProjectionTemp >::nearfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::peek(), trklet::CircularBuffer< trklet::ProjectionTemp >::read(), trklet::CircularBuffer< trklet::ProjectionTemp >::reset(), trklet::CircularBuffer< trklet::ProjectionTemp >::rptr(), and trklet::CircularBuffer< trklet::ProjectionTemp >::store().

size_

template<class T>

unsigned int trklet::CircularBuffer< T >::size_

private

Definition at line 66 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::almostfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::CircularBuffer(), trklet::CircularBuffer< trklet::ProjectionTemp >::full(), trklet::CircularBuffer< trklet::ProjectionTemp >::nearfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::read(), and trklet::CircularBuffer< trklet::ProjectionTemp >::store().

wptr_

template<class T>

unsigned int trklet::CircularBuffer< T >::wptr_

private

Definition at line 70 of file CircularBuffer.h.

Referenced by trklet::CircularBuffer< trklet::ProjectionTemp >::almostfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::empty(), trklet::CircularBuffer< trklet::ProjectionTemp >::full(), trklet::CircularBuffer< trklet::ProjectionTemp >::nearfull(), trklet::CircularBuffer< trklet::ProjectionTemp >::reset(), trklet::CircularBuffer< trklet::ProjectionTemp >::store(), and trklet::CircularBuffer< trklet::ProjectionTemp >::wptr().