Detailed Description

template<typename T>
class mrpt::containers::circular_buffer< T >

A circular buffer of fixed size (defined at construction-time), implemented with a std::vector as the underlying storage.

Note: Defined in #include <mrpt/containers/circular_buffer.h>

Definition at line 23 of file circular_buffer.h.

#include <mrpt/containers/circular_buffer.h>

Inheritance diagram for mrpt::containers::circular_buffer< T >:

Public Member Functions
	circular_buffer (const size_t size)

void	push (T d)
	Insert a copy of the given element in the buffer. More...

void	push_ref (const T &d)
	Insert a reference of the given element in the buffer. More...

void	push_many (T *array_elements, size_t count)
	Insert an array of elements in the buffer. More...

T	pop ()
	Retrieve an element from the buffer. More...

void	pop (T &out_val)
	Retrieve an element from the buffer. More...

void	pop_many (T *out_array, size_t count)
	Pop a number of elements into a user-provided array. More...

T	peek () const
	Peek (see without modifying) what is to be read from the buffer if pop() was to be called. More...

T	peek (size_t index) const
	Like peek(), but seeking ahead in the buffer (index=0 means the immediate next element, index=1 the following one, etc.) More...

void	peek_many (T *out_array, size_t count) const
	Like peek(), for multiple elements, storing a number of elements into a user-provided array. More...

size_t	size () const
	Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size of the internal buffer) More...

size_t	capacity () const
	Return the maximum capacity of the buffer. More...

size_t	available () const
	The maximum number of elements that can be written ("push") without rising an overflow error. More...

void	clear ()
	Delete all the stored data, if any. More...

Private Attributes
std::vector< T >	m_data

size_t	m_size
	not "const" to allow copy/move = ops. More...

size_t	m_next_read

size_t	m_next_write

Constructor & Destructor Documentation

◆ circular_buffer()

template<typename T>

mrpt::containers::circular_buffer< T >::circular_buffer ( const size_t size )

inline

Definition at line 32 of file circular_buffer.h.

Member Function Documentation

◆ available()

template<typename T>

size_t mrpt::containers::circular_buffer< T >::available ( ) const

inline

The maximum number of elements that can be written ("push") without rising an overflow error.

Definition at line 159 of file circular_buffer.h.

Referenced by mrpt::hwdrivers::CHokuyoURG::assureBufferHasBytes(), mrpt::hwdrivers::CGPSInterface::doProcess(), and mrpt::comms::CInterfaceFTDI::Read().

◆ capacity()

template<typename T>

size_t mrpt::containers::circular_buffer< T >::capacity ( ) const

inline

Return the maximum capacity of the buffer.

See also: size

Definition at line 155 of file circular_buffer.h.

Referenced by mrpt::hwdrivers::CHokuyoURG::assureBufferHasBytes(), mrpt::containers::circular_buffer< uint8_t >::available(), and TEST().

◆ clear()

template<typename T>

void mrpt::containers::circular_buffer< T >::clear ( )

inline

Delete all the stored data, if any.

Definition at line 161 of file circular_buffer.h.

Referenced by mrpt::comms::CInterfaceFTDI::Close(), mrpt::comms::CInterfaceFTDI::OpenByDescription(), mrpt::comms::CInterfaceFTDI::OpenBySerialNumber(), mrpt::comms::CInterfaceFTDI::Purge(), and mrpt::comms::CInterfaceFTDI::ResetDevice().

◆ peek() [1/2]

template<typename T>

T mrpt::containers::circular_buffer< T >::peek ( ) const

inline

Peek (see without modifying) what is to be read from the buffer if pop() was to be called.

Exceptions

std::out_of_range If the buffer is empty.

Definition at line 107 of file circular_buffer.h.

Referenced by TEST().

◆ peek() [2/2]

template<typename T>

T mrpt::containers::circular_buffer< T >::peek ( size_t index ) const

inline

Like peek(), but seeking ahead in the buffer (index=0 means the immediate next element, index=1 the following one, etc.)

Exceptions

std::out_of_range If trying to read passing the number of available elements.

Definition at line 117 of file circular_buffer.h.

◆ peek_many()

template<typename T>

void mrpt::containers::circular_buffer< T >::peek_many	(	T *	out_array,
		size_t	count
	)		const

inline

Like peek(), for multiple elements, storing a number of elements into a user-provided array.

Exceptions

std::out_of_range If the buffer has less elements than requested.

Definition at line 128 of file circular_buffer.h.

Referenced by TEST().

◆ pop() [1/2]

template<typename T>

T mrpt::containers::circular_buffer< T >::pop ( )

inline

Retrieve an element from the buffer.

Exceptions

std::out_of_range If the buffer is empty.

Definition at line 74 of file circular_buffer.h.

Referenced by mrpt::hwdrivers::CGPSInterface::parseBuffer(), mrpt::containers::circular_buffer< uint8_t >::pop_many(), mrpt::hwdrivers::CHokuyoURG::receiveResponse(), and TEST().

◆ pop() [2/2]

template<typename T>

void mrpt::containers::circular_buffer< T >::pop ( T & out_val )

inline

Retrieve an element from the buffer.

Exceptions

std::out_of_range If the buffer is empty.

Definition at line 87 of file circular_buffer.h.

◆ pop_many()

template<typename T>

void mrpt::containers::circular_buffer< T >::pop_many	(	T *	out_array,
		size_t	count
	)

inline

Pop a number of elements into a user-provided array.

Exceptions

std::out_of_range If the buffer has less elements than requested.

Definition at line 99 of file circular_buffer.h.

Referenced by mrpt::comms::CInterfaceFTDI::Read(), and TEST().

◆ push()

template<typename T>

void mrpt::containers::circular_buffer< T >::push ( T d )

inline

Insert a copy of the given element in the buffer.

Exceptions

std::out_of_range If the buffer run out of space.

Definition at line 41 of file circular_buffer.h.

Referenced by mrpt::containers::circular_buffer< uint8_t >::push_many(), and TEST().

◆ push_many()

template<typename T>

void mrpt::containers::circular_buffer< T >::push_many	(	T *	array_elements,
		size_t	count
	)

inline

Insert an array of elements in the buffer.

Exceptions

std::out_of_range If the buffer run out of space.

Definition at line 66 of file circular_buffer.h.

Referenced by mrpt::hwdrivers::CHokuyoURG::assureBufferHasBytes(), mrpt::hwdrivers::CGPSInterface::doProcess(), mrpt::comms::CInterfaceFTDI::Read(), and TEST().

◆ push_ref()

template<typename T>

void mrpt::containers::circular_buffer< T >::push_ref ( const T & d )

inline

Insert a reference of the given element in the buffer.

Exceptions

std::out_of_range If the buffer run out of space.

Definition at line 54 of file circular_buffer.h.

◆ size()

template<typename T>

size_t mrpt::containers::circular_buffer< T >::size ( ) const

inline

Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size of the internal buffer)

See also: capacity

Definition at line 144 of file circular_buffer.h.

Referenced by mrpt::hwdrivers::CHokuyoURG::assureBufferHasBytes(), mrpt::containers::circular_buffer< uint8_t >::available(), mrpt::hwdrivers::CGPSInterface::parseBuffer(), mrpt::containers::circular_buffer< uint8_t >::peek(), mrpt::comms::CInterfaceFTDI::Read(), and TEST().

Member Data Documentation

◆ m_data

template<typename T>

std::vector<T> mrpt::containers::circular_buffer< T >::m_data

private

Definition at line 26 of file circular_buffer.h.

Referenced by mrpt::containers::circular_buffer< uint8_t >::peek(), mrpt::containers::circular_buffer< uint8_t >::peek_many(), mrpt::containers::circular_buffer< uint8_t >::pop(), mrpt::containers::circular_buffer< uint8_t >::push(), and mrpt::containers::circular_buffer< uint8_t >::push_ref().

◆ m_next_read

template<typename T>

size_t mrpt::containers::circular_buffer< T >::m_next_read

private

Definition at line 29 of file circular_buffer.h.

Referenced by mrpt::containers::circular_buffer< uint8_t >::clear(), mrpt::containers::circular_buffer< uint8_t >::peek(), mrpt::containers::circular_buffer< uint8_t >::peek_many(), mrpt::containers::circular_buffer< uint8_t >::pop(), mrpt::containers::circular_buffer< uint8_t >::push(), mrpt::containers::circular_buffer< uint8_t >::push_ref(), and mrpt::containers::circular_buffer< uint8_t >::size().

◆ m_next_write

template<typename T>

size_t mrpt::containers::circular_buffer< T >::m_next_write

private

Definition at line 29 of file circular_buffer.h.

Referenced by mrpt::containers::circular_buffer< uint8_t >::clear(), mrpt::containers::circular_buffer< uint8_t >::peek(), mrpt::containers::circular_buffer< uint8_t >::peek_many(), mrpt::containers::circular_buffer< uint8_t >::pop(), mrpt::containers::circular_buffer< uint8_t >::push(), mrpt::containers::circular_buffer< uint8_t >::push_ref(), and mrpt::containers::circular_buffer< uint8_t >::size().

◆ m_size

template<typename T>

size_t mrpt::containers::circular_buffer< T >::m_size

private

not "const" to allow copy/move = ops.

Definition at line 28 of file circular_buffer.h.

Referenced by mrpt::containers::circular_buffer< uint8_t >::capacity(), mrpt::containers::circular_buffer< uint8_t >::circular_buffer(), mrpt::containers::circular_buffer< uint8_t >::peek(), mrpt::containers::circular_buffer< uint8_t >::peek_many(), mrpt::containers::circular_buffer< uint8_t >::pop(), mrpt::containers::circular_buffer< uint8_t >::push(), mrpt::containers::circular_buffer< uint8_t >::push_ref(), and mrpt::containers::circular_buffer< uint8_t >::size().

Detailed Description

template<typename T> class mrpt::containers::circular_buffer< T >

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ circular_buffer()

Member Function Documentation

◆ available()

◆ capacity()

◆ clear()

◆ peek() [1/2]

◆ peek() [2/2]

◆ peek_many()

◆ pop() [1/2]

◆ pop() [2/2]

◆ pop_many()

◆ push()

◆ push_many()

◆ push_ref()

◆ size()

Member Data Documentation

◆ m_data

◆ m_next_read

◆ m_next_write

◆ m_size

template<typename T>
class mrpt::containers::circular_buffer< T >