MNE-CPP  beta 1.0
Public Types | Public Member Functions | List of all members
IOBuffer::CircularBuffer_old< _Tp > Class Template Reference

The TEMPLATE CIRCULAR BUFFER provides a template for thread safe circular buffers. More...

#include <circularbuffer_old.h>

Inheritance diagram for IOBuffer::CircularBuffer_old< _Tp >:
IOBuffer::Buffer

Public Types

typedef QSharedPointer< CircularBuffer_oldSPtr
 
typedef QSharedPointer< const CircularBuffer_oldConstSPtr
 
- Public Types inherited from IOBuffer::Buffer
typedef QSharedPointer< BufferSPtr
 
typedef QSharedPointer< const BufferConstSPtr
 

Public Member Functions

 CircularBuffer_old (unsigned int uiMaxNumElements)
 
 ~CircularBuffer_old ()
 
void push (const _Tp *pArray, unsigned int size)
 
void push (const _Tp &newElement)
 
_Tp pop ()
 
void clear ()
 
- Public Member Functions inherited from IOBuffer::Buffer
 Buffer (const char *type_id)
 
const char * getTypeId ()
 

Detailed Description

template<typename _Tp>
class IOBuffer::CircularBuffer_old< _Tp >

The TEMPLATE CIRCULAR BUFFER provides a template for thread safe circular buffers.

TEMPLATE CIRCULAR BUFFER

Definition at line 92 of file circularbuffer_old.h.

Member Typedef Documentation

template<typename _Tp >
typedef QSharedPointer<const CircularBuffer_old> IOBuffer::CircularBuffer_old< _Tp >::ConstSPtr

Const shared pointer type for CircularBuffer_old.

Definition at line 96 of file circularbuffer_old.h.

template<typename _Tp >
typedef QSharedPointer<CircularBuffer_old> IOBuffer::CircularBuffer_old< _Tp >::SPtr

Shared pointer type for CircularBuffer_old.

Definition at line 95 of file circularbuffer_old.h.

Constructor & Destructor Documentation

template<typename _Tp >
IOBuffer::CircularBuffer_old< _Tp >::CircularBuffer_old ( unsigned int  uiMaxNumElements)

Constructs a CircularBuffer.

Parameters
[in]uiMaxNumElementslength of buffer.

Definition at line 164 of file circularbuffer_old.h.

template<typename _Tp >
IOBuffer::CircularBuffer_old< _Tp >::~CircularBuffer_old ( )

Destroys the CircularBuffer.

Definition at line 180 of file circularbuffer_old.h.

Member Function Documentation

template<typename _Tp >
void IOBuffer::CircularBuffer_old< _Tp >::clear ( )

Clears the buffer.

Definition at line 236 of file circularbuffer_old.h.

template<typename _Tp >
_Tp IOBuffer::CircularBuffer_old< _Tp >::pop ( )
inline

Returns the first element (first in first out).

Returns
the first element

Definition at line 214 of file circularbuffer_old.h.

template<typename _Tp >
void IOBuffer::CircularBuffer_old< _Tp >::push ( const _Tp *  pArray,
unsigned int  size 
)
inline

Adds a whole array at the end buffer.

Parameters
[in]pArraypointer to an Array which should be apend to the end.
[in]sizenumber of elements containing the array.

Definition at line 191 of file circularbuffer_old.h.

template<typename _Tp >
void IOBuffer::CircularBuffer_old< _Tp >::push ( const _Tp &  newElement)
inline

Adds an element at the end of the buffer.

Parameters
[in]newElementpointer to an Array which should be apend to the end.

Definition at line 203 of file circularbuffer_old.h.


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