filters::RealtimeCircularBuffer< T > Class Template Reference

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

#include <realtime_circular_buffer.h>

List of all members.

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.h.


Constructor & Destructor Documentation

template<typename T>
filters::RealtimeCircularBuffer< T >::RealtimeCircularBuffer (  )  [private]
template<typename T>
filters::RealtimeCircularBuffer< T >::RealtimeCircularBuffer ( int  size,
const T &  default_val 
) [inline]

Definition at line 53 of file realtime_circular_buffer.h.


Member Function Documentation

template<typename T>
T& filters::RealtimeCircularBuffer< T >::at ( size_t  index  )  [inline]

Definition at line 97 of file realtime_circular_buffer.h.

template<typename T>
T& filters::RealtimeCircularBuffer< T >::back (  )  [inline]

Definition at line 87 of file realtime_circular_buffer.h.

template<typename T>
void filters::RealtimeCircularBuffer< T >::clear (  )  [inline]

Definition at line 82 of file realtime_circular_buffer.h.

template<typename T>
bool filters::RealtimeCircularBuffer< T >::empty (  )  [inline]

Definition at line 96 of file realtime_circular_buffer.h.

template<typename T>
T& filters::RealtimeCircularBuffer< T >::front (  )  [inline]

Definition at line 86 of file realtime_circular_buffer.h.

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

Definition at line 98 of file realtime_circular_buffer.h.

template<typename T>
void filters::RealtimeCircularBuffer< T >::push_back ( const T &  item  )  [inline]

Definition at line 62 of file realtime_circular_buffer.h.

template<typename T>
void filters::RealtimeCircularBuffer< T >::push_front ( const T &  item  )  [inline]

Definition at line 75 of file realtime_circular_buffer.h.

template<typename T>
void filters::RealtimeCircularBuffer< T >::set_capacity ( unsigned int  order,
const T &  value 
)
template<typename T>
unsigned int filters::RealtimeCircularBuffer< T >::size (  )  [inline]

Definition at line 95 of file realtime_circular_buffer.h.


Member Data Documentation

template<typename T>
boost::circular_buffer<T> filters::RealtimeCircularBuffer< T >::cb_ [private]

Definition at line 103 of file realtime_circular_buffer.h.

template<typename T>
unsigned int filters::RealtimeCircularBuffer< T >::counter_ [private]

Definition at line 101 of file realtime_circular_buffer.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Defines


filters
Author(s): Tully Foote/tfoote@willowgarage.com
autogenerated on Fri Jan 11 09:33:18 2013