filters::RealtimeCircularBuffer< T > Class Template Reference

A realtime safe circular (ring) buffer. More...

#include <realtime_circular_buffer.hpp>

Public Member Functions
T &	at (size_t index)
T &	back ()
void	clear ()
bool	empty ()
T &	front ()
T &	operator[] (size_t index)
void	push_back (const T &item)
void	push_front (const T &item)
	RealtimeCircularBuffer (int size, const T &default_val)
void	set_capacity (unsigned int order, const T &value)
unsigned int	size ()

Private Member Functions
	RealtimeCircularBuffer ()

Private Attributes
boost::circular_buffer< T >	cb_
unsigned int	counter_

Detailed Description

template<typename T>
class filters::RealtimeCircularBuffer< T >

A realtime safe circular (ring) buffer.

Definition at line 47 of file realtime_circular_buffer.hpp.

Constructor & Destructor Documentation

RealtimeCircularBuffer() [1/2]

template<typename T >

filters::RealtimeCircularBuffer< T >::RealtimeCircularBuffer ( )

private

RealtimeCircularBuffer() [2/2]

template<typename T >

filters::RealtimeCircularBuffer< T >::RealtimeCircularBuffer ( int  size, const T &  default_val  )

inline

Definition at line 53 of file realtime_circular_buffer.hpp.

Member Function Documentation

at()

template<typename T >

T& filters::RealtimeCircularBuffer< T >::at ( size_t  index )

inline

Definition at line 97 of file realtime_circular_buffer.hpp.

back()

template<typename T >

T& filters::RealtimeCircularBuffer< T >::back ( )

inline

Definition at line 87 of file realtime_circular_buffer.hpp.

clear()

template<typename T >

void filters::RealtimeCircularBuffer< T >::clear ( )

inline

Definition at line 82 of file realtime_circular_buffer.hpp.

empty()

template<typename T >

bool filters::RealtimeCircularBuffer< T >::empty ( )

inline

Definition at line 96 of file realtime_circular_buffer.hpp.

front()

template<typename T >

T& filters::RealtimeCircularBuffer< T >::front ( )

inline

Definition at line 86 of file realtime_circular_buffer.hpp.

operator[]()

template<typename T >

T& filters::RealtimeCircularBuffer< T >::operator[] ( size_t  index )

inline

Definition at line 98 of file realtime_circular_buffer.hpp.

push_back()

template<typename T >

void filters::RealtimeCircularBuffer< T >::push_back ( const T &  item )

inline

Definition at line 62 of file realtime_circular_buffer.hpp.

push_front()

template<typename T >

void filters::RealtimeCircularBuffer< T >::push_front ( const T &  item )

inline

Definition at line 75 of file realtime_circular_buffer.hpp.

set_capacity()

template<typename T >

void filters::RealtimeCircularBuffer< T >::set_capacity	(	unsigned int	order,
		const T &	value
	)

size()

template<typename T >

unsigned int filters::RealtimeCircularBuffer< T >::size ( )

inline

Definition at line 95 of file realtime_circular_buffer.hpp.

Member Data Documentation

cb_

template<typename T >

boost::circular_buffer<T> filters::RealtimeCircularBuffer< T >::cb_

private

Definition at line 103 of file realtime_circular_buffer.hpp.

counter_

template<typename T >

unsigned int filters::RealtimeCircularBuffer< T >::counter_

private

Definition at line 101 of file realtime_circular_buffer.hpp.

---

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

• realtime_circular_buffer.hpp