Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | 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.

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

Definition at line 24 of file circular_buffer.h.

#include <mrpt/utils/circular_buffer.h>

Inheritance diagram for mrpt::utils::circular_buffer< T >:
Inheritance graph

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...
 
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...
 
peek () const
 Peek (see without modifying) what is to be read from the buffer if pop() was to be called. More...
 
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.)

Exceptions
std::out_of_rangeIf trying to read passing the number of available elements.
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
 
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 32 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 146 of file circular_buffer.h.

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

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 140 of file circular_buffer.h.

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

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

Delete all the stored data, if any.

Definition at line 151 of file circular_buffer.h.

template<typename T>
T mrpt::utils::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_rangeIf the buffer is empty.

Definition at line 105 of file circular_buffer.h.

Referenced by TEST().

template<typename T>
T mrpt::utils::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_rangeIf trying to read passing the number of available elements.

Definition at line 111 of file circular_buffer.h.

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

Definition at line 118 of file circular_buffer.h.

Referenced by TEST().

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 76 of file circular_buffer.h.

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

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 88 of file circular_buffer.h.

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 98 of file circular_buffer.h.

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

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 45 of file circular_buffer.h.

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

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 68 of file circular_buffer.h.

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

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 57 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 131 of file circular_buffer.h.

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

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.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018