RingBuffer< T, size > Class Template Reference

RingBuffer (circular buffer) template class A small circular queue to hold a fixed number of elements. More...

#include <Queue.hpp>

Collaboration diagram for RingBuffer< T, size >:

Public Member Functions
constexpr	RingBuffer ()
void	push (T val)
	Pushes a new value into the ring buffer. This will overwrite the oldest value if the buffer is full.
void	getLinearBuffer (T *out)
	Returns the elements in the buffer in linear order.

Public Attributes
T	buffer [size]
uint8_t	head
uint8_t	count

Detailed Description

template<typename T, uint8_t size>
class RingBuffer< T, size >

RingBuffer (circular buffer) template class A small circular queue to hold a fixed number of elements.

Template Parameters

T	Type of elements stored in the buffer
size	Capacity of the buffer

Definition at line 24 of file Queue.hpp.

Constructor & Destructor Documentation

RingBuffer()

template<typename T , uint8_t size>

constexpr RingBuffer< T, size >::RingBuffer ( )

inlineconstexpr

Definition at line 29 of file Queue.hpp.

Member Function Documentation

getLinearBuffer()

template<typename T , uint8_t size>

void RingBuffer< T, size >::getLinearBuffer ( T *  out )

inline

Returns the elements in the buffer in linear order.

Parameters

out	Pointer to an array where the linear buffer will be stored. This array shall be created by the caller and must have at least 'size' elements.

Note

The order of elements in the output array will be from oldest to newest.

Definition at line 51 of file Queue.hpp.

References RingBuffer< T, size >::buffer, RingBuffer< T, size >::count, and RingBuffer< T, size >::head.

push()

template<typename T , uint8_t size>

void RingBuffer< T, size >::push ( T  val )

inline

Pushes a new value into the ring buffer. This will overwrite the oldest value if the buffer is full.

Parameters

val	The value to be added to the buffer.

Definition at line 37 of file Queue.hpp.

References RingBuffer< T, size >::buffer, RingBuffer< T, size >::count, and RingBuffer< T, size >::head.

Member Data Documentation

buffer

template<typename T , uint8_t size>

T RingBuffer< T, size >::buffer[size]

Definition at line 62 of file Queue.hpp.

Referenced by RingBuffer< T, size >::getLinearBuffer(), and RingBuffer< T, size >::push().

count

template<typename T , uint8_t size>

uint8_t RingBuffer< T, size >::count

Definition at line 64 of file Queue.hpp.

Referenced by RingBuffer< T, size >::getLinearBuffer(), and RingBuffer< T, size >::push().

head

template<typename T , uint8_t size>

uint8_t RingBuffer< T, size >::head

Definition at line 63 of file Queue.hpp.

Referenced by RingBuffer< T, size >::getLinearBuffer(), and RingBuffer< T, size >::push().

---

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

• vehicle_control_unit/lib/Queue/Queue.hpp