RingBuffer< T > Class Template Reference

Implements a typed Ringbuffer. More...

#include <Buffers.h>

Inheritance diagram for RingBuffer< T >:

Collaboration diagram for RingBuffer< T >:

Public Member Functions
	RingBuffer (int size)
bool	read (T &result) override
	reads a single value
bool	peek (T &result) override
	peeks the actual entry from the buffer
virtual int	peekArray (T *data, int n)
virtual bool	isFull () override
	checks if the buffer is full
bool	isEmpty ()
virtual bool	write (T data) override
	write add an entry to the buffer
virtual void	reset () override
	clears the buffer
virtual int	available () override
	provides the number of entries that are available to read
virtual int	availableForWrite () override
	provides the number of entries that are available to write
virtual T *	address () override
	returns the address of the start of the physical read buffer
virtual bool	resize (int len)
	Resizes the buffer if supported: returns false if not supported.
virtual size_t	size () override
	Returns the maximum capacity of the buffer.
Public Member Functions inherited from BaseBuffer< T >
	BaseBuffer (BaseBuffer &)=default
BaseBuffer &	operator= (BaseBuffer &)=default
virtual bool	read (T &result)=0
	reads a single value
virtual int	readArray (T data[], int len)
	reads multiple values
virtual int	clearArray (int len)
	Removes the next len entries.
virtual int	writeArray (const T data[], int len)
	Fills the buffer data.
virtual int	writeArrayOverwrite (const T data[], int len)
	Fills the buffer data and overwrites the oldest data if the buffer is full.
virtual bool	peek (T &result)=0
	peeks the actual entry from the buffer
virtual bool	isFull ()
	checks if the buffer is full
bool	isEmpty ()
virtual bool	write (T data)=0
	write add an entry to the buffer
virtual void	reset ()=0
	clears the buffer
void	clear ()
	same as reset
virtual int	available ()=0
	provides the number of entries that are available to read
virtual int	availableForWrite ()=0
	provides the number of entries that are available to write
virtual T *	address ()=0
	returns the address of the start of the physical read buffer
virtual size_t	size ()=0
virtual float	levelPercent ()
	Returns the level of the buffer in %.
virtual bool	resize (int bytes)
	Resizes the buffer if supported: returns false if not supported.

Protected Member Functions
int	nextIndex (int index)

Protected Attributes
std::vector< T >	_aucBuffer
int	_iHead
int	_iTail
int	_numElems
int	max_size = 0

Detailed Description

template<typename T = int16_t>
class tinyrobotics::RingBuffer< T >

Implements a typed Ringbuffer.

Template Parameters

T

Member Function Documentation

address()

virtual T * address ( )

inlineoverridevirtual

returns the address of the start of the physical read buffer

Implements BaseBuffer< T >.

available()

virtual int available ( )

inlineoverridevirtual

provides the number of entries that are available to read

Implements BaseBuffer< T >.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtual

provides the number of entries that are available to write

Implements BaseBuffer< T >.

isFull()

virtual bool isFull ( )

inlineoverridevirtual

checks if the buffer is full

Reimplemented from BaseBuffer< T >.

peek()

bool peek ( T &  result )

inlineoverridevirtual

peeks the actual entry from the buffer

Implements BaseBuffer< T >.

read()

bool read ( T &  result )

inlineoverridevirtual

reads a single value

Implements BaseBuffer< T >.

reset()

virtual void reset ( )

inlineoverridevirtual

clears the buffer

Implements BaseBuffer< T >.

resize()

virtual bool resize ( int  bytes )

inlinevirtual

Resizes the buffer if supported: returns false if not supported.

Reimplemented from BaseBuffer< T >.

size()

virtual size_t size ( )

inlineoverridevirtual

Returns the maximum capacity of the buffer.

Implements BaseBuffer< T >.

write()

virtual bool write ( T  data )

inlineoverridevirtual

write add an entry to the buffer

Implements BaseBuffer< T >.

---

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

• src/TinyRobotics/utils/Buffers.h