Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Private Attributes

mrpt::utils::circular_buffer< T > Class Template Reference


Detailed Description

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

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

Definition at line 43 of file circular_buffer.h.

#include <mrpt/utils/circular_buffer.h>

Inheritance diagram for mrpt::utils::circular_buffer< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 circular_buffer (const size_t size)
void push (T d)
 Insert a copy of the given element in the buffer.
void push_ref (const T &d)
 Insert a reference of the given element in the buffer.
void push_many (T *array_elements, size_t count)
 Insert an array of elements in the buffer.
pop ()
 Retrieve an element from the buffer.
void pop (T &out_val)
 Retrieve an element from the buffer.
void pop_many (T *out_array, size_t count)
 Pop a number of elements into a user-provided array.
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)
size_t capacity () const
 Return the maximum capacity of the buffer.
size_t available () const
 The maximum number of elements that can be written ("push") without rising an overflow error.
void clear ()
 Delete all the stored data, if any.

Private Attributes

std::vector< T > m_data
const size_t m_size
size_t m_next_read
size_t m_next_write

Constructor & Destructor Documentation

template<typename T>
mrpt::utils::circular_buffer< T >::circular_buffer ( const size_t  size) [inline]

Definition at line 51 of file circular_buffer.h.


Member Function Documentation

template<typename T>
size_t mrpt::utils::circular_buffer< T >::available ( ) const [inline]

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

Definition at line 140 of file circular_buffer.h.

template<typename T>
size_t mrpt::utils::circular_buffer< T >::capacity ( ) const [inline]

Return the maximum capacity of the buffer.

See also:
size

Definition at line 134 of file circular_buffer.h.

Referenced by mrpt::utils::circular_buffer< uint8_t >::available().

template<typename T>
void mrpt::utils::circular_buffer< T >::clear ( void  ) [inline]

Delete all the stored data, if any.

Definition at line 145 of file circular_buffer.h.

template<typename T>
void mrpt::utils::circular_buffer< T >::pop ( T &  out_val) [inline]

Retrieve an element from the buffer.

Exceptions:
std::out_of_rangeIf the buffer is empty.

Definition at line 106 of file circular_buffer.h.

template<typename T>
T mrpt::utils::circular_buffer< T >::pop ( ) [inline]

Retrieve an element from the buffer.

Exceptions:
std::out_of_rangeIf the buffer is empty.

Definition at line 94 of file circular_buffer.h.

Referenced by mrpt::utils::circular_buffer< uint8_t >::pop_many().

template<typename T>
void mrpt::utils::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_rangeIf the buffer has less elements than requested.

Definition at line 117 of file circular_buffer.h.

template<typename T>
void mrpt::utils::circular_buffer< T >::push ( d) [inline]

Insert a copy of the given element in the buffer.

Exceptions:
std::out_of_rangeIf the buffer run out of space.

Definition at line 64 of file circular_buffer.h.

Referenced by mrpt::utils::circular_buffer< uint8_t >::push_many().

template<typename T>
void mrpt::utils::circular_buffer< T >::push_many ( T *  array_elements,
size_t  count 
) [inline]

Insert an array of elements in the buffer.

Exceptions:
std::out_of_rangeIf the buffer run out of space.

Definition at line 86 of file circular_buffer.h.

template<typename T>
void mrpt::utils::circular_buffer< T >::push_ref ( const T &  d) [inline]

Insert a reference of the given element in the buffer.

Exceptions:
std::out_of_rangeIf the buffer run out of space.

Definition at line 75 of file circular_buffer.h.

template<typename T>
size_t mrpt::utils::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 125 of file circular_buffer.h.

Referenced by mrpt::utils::circular_buffer< uint8_t >::available().


Member Data Documentation

template<typename T>
std::vector<T> mrpt::utils::circular_buffer< T >::m_data [private]
template<typename T>
size_t mrpt::utils::circular_buffer< T >::m_next_read [private]
template<typename T>
size_t mrpt::utils::circular_buffer< T >::m_next_write [private]
template<typename T>
const size_t mrpt::utils::circular_buffer< T >::m_size [private]



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011