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

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

#include <circularmultichannelbuffer_old.h>

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

Public Types

typedef QSharedPointer< CircularMultiChannelBuffer_oldSPtr
 
typedef QSharedPointer< const CircularMultiChannelBuffer_oldConstSPtr
 
- Public Types inherited from IOBuffer::Buffer
typedef QSharedPointer< BufferSPtr
 
typedef QSharedPointer< const BufferConstSPtr
 

Public Member Functions

 CircularMultiChannelBuffer_old (unsigned int uiNumChannels, unsigned int uiMaxNumElements)
 
 ~CircularMultiChannelBuffer_old ()
 
void init ()
 
void push (unsigned int uiChannel, const _Tp *pArray, unsigned int size)
 
void push (unsigned int uiChannel, const _Tp &newElement)
 
void push (const QVector< _Tp > &newElements)
 
QVector< _Tp > pop ()
 
_Tp pop (unsigned int uiChannel)
 
int numChannels ()
 
void clear ()
 
- Public Member Functions inherited from IOBuffer::Buffer
 Buffer (const char *type_id)
 
const char * getTypeId ()
 

Detailed Description

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

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

TEMPLATE CIRCULAR BUFFER

Definition at line 90 of file circularmultichannelbuffer_old.h.

Member Typedef Documentation

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

Const shared pointer type for CircularMultiChannelBuffer_old.

Definition at line 96 of file circularmultichannelbuffer_old.h.

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

Shared pointer type for CircularMultiChannelBuffer_old.

Definition at line 95 of file circularmultichannelbuffer_old.h.

Constructor & Destructor Documentation

template<typename _Tp >
IOBuffer::CircularMultiChannelBuffer_old< _Tp >::CircularMultiChannelBuffer_old ( unsigned int  uiNumChannels,
unsigned int  uiMaxNumElements 
)

Constructs a CircularMultiChannelBuffer_old.

Parameters
[in]uiChannelselected channel.
[in]uiMaxNumElementslength of buffer.

Definition at line 191 of file circularmultichannelbuffer_old.h.

Destroys the CircularMultiChannelBuffer_old.

Definition at line 203 of file circularmultichannelbuffer_old.h.

Member Function Documentation

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

Clears the buffer.

Definition at line 291 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
void IOBuffer::CircularMultiChannelBuffer_old< _Tp >::init ( )

Initializes the buffer.

Definition at line 213 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
int IOBuffer::CircularMultiChannelBuffer_old< _Tp >::numChannels ( )
inline

Returns the number of channels.

Definition at line 230 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
QVector< _Tp > IOBuffer::CircularMultiChannelBuffer_old< _Tp >::pop ( )
inline

Returns the first element (first in first out).

Returns
the first element

Definition at line 267 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
_Tp IOBuffer::CircularMultiChannelBuffer_old< _Tp >::pop ( unsigned int  uiChannel)
inline

Returns the first element (first in first out) of a specific channel.

Parameters
[in]uiChannelselected channel.
Returns
the first element of the specific channel

Definition at line 282 of file circularmultichannelbuffer_old.h.

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

Adds a whole array at the end buffer.

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

Definition at line 239 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
void IOBuffer::CircularMultiChannelBuffer_old< _Tp >::push ( unsigned int  uiChannel,
const _Tp &  newElement 
)
inline

Adds an element at the end of the buffer.

Parameters
[in]uiChannelselected channel.
[in]newElementpointer to an Array which should be append to the end.

Definition at line 248 of file circularmultichannelbuffer_old.h.

template<typename _Tp >
void IOBuffer::CircularMultiChannelBuffer_old< _Tp >::push ( const QVector< _Tp > &  newElements)
inline

Adds an element at the end of the buffer.

Parameters
[in]newElementsvector which should be added to the channels.

Definition at line 257 of file circularmultichannelbuffer_old.h.


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