RingBuffer< DataType, Size > Class Template Reference

#include <midi_RingBuffer.h>

Public Member Functions
	RingBuffer ()
	~RingBuffer ()
int	getLength () const
bool	isEmpty () const
void	write (DataType inData)
void	write (const DataType *inData, int inSize)
void	clear ()
DataType	read ()
void	read (DataType *outData, int inSize)

Detailed Description

template<typename DataType, int Size>
class RingBuffer< DataType, Size >

Definition at line 35 of file midi_RingBuffer.h.

Constructor & Destructor Documentation

RingBuffer()

template<typename DataType , int Size>

BEGIN_MIDI_NAMESPACE RingBuffer< DataType, Size >::RingBuffer

(

)

Definition at line 33 of file midi_RingBuffer.hpp.

    : mWriteHead(mData)
    , mReadHead(mData)
{
    memset(mData, DataType(0), Size * sizeof(DataType));
}

~RingBuffer()

template<typename DataType , int Size>

RingBuffer< DataType, Size >::~RingBuffer

(

)

Definition at line 41 of file midi_RingBuffer.hpp.

{
}

Member Function Documentation

clear()

template<typename DataType , int Size>

void RingBuffer< DataType, Size >::clear

(

)

Definition at line 92 of file midi_RingBuffer.hpp.

{
    memset(mData, DataType(0), Size * sizeof(DataType));
    mReadHead  = mData;
    mWriteHead = mData;
}

getLength()

template<typename DataType , int Size>

int RingBuffer< DataType, Size >::getLength

(

)

const

Definition at line 48 of file midi_RingBuffer.hpp.

{
    if (mReadHead == mWriteHead)
    {
        return 0;
    }
    else if (mWriteHead > mReadHead)
    {
        return int(mWriteHead - mReadHead);
    }
    else
    {
        return int(mWriteHead - mData) + Size - int(mReadHead - mData);
    }
}

isEmpty()

template<typename DataType , int Size>

bool RingBuffer< DataType, Size >::isEmpty

(

)

const

Definition at line 65 of file midi_RingBuffer.hpp.

{
    return mReadHead == mWriteHead;
}

read() [1/2]

template<typename DataType , int Size>

DataType RingBuffer< DataType, Size >::read

(

)

Definition at line 102 of file midi_RingBuffer.hpp.

{
    const DataType data = *mReadHead++;
    if (mReadHead >= mData + Size)
    {
        mReadHead = mData;
    }
    return data;
}

read() [2/2]

template<typename DataType, int Size>

void RingBuffer< DataType, Size >::read	(	DataType *	outData,
		int	inSize
	)

Definition at line 113 of file midi_RingBuffer.hpp.

{
    for (int i = 0; i < inSize; ++i)
    {
        outData[i] = read();
    }
}

write() [1/2]

template<typename DataType, int Size>

void RingBuffer< DataType, Size >::write

(

DataType

inData

)

Definition at line 73 of file midi_RingBuffer.hpp.

{
    *mWriteHead++ = inData;
    if (mWriteHead >= mData + Size)
    {
        mWriteHead = mData;
    }
}

write() [2/2]

template<typename DataType, int Size>

void RingBuffer< DataType, Size >::write	(	const DataType *	inData,
		int	inSize
	)

Definition at line 83 of file midi_RingBuffer.hpp.

{
    for (int i = 0; i < inSize; ++i)
    {
        write(inData[i]);
    }
}

---

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

• /Users/franky/dev/git/arduino_midi_library/src/midi_RingBuffer.h
• /Users/franky/dev/git/arduino_midi_library/src/midi_RingBuffer.hpp