Orocos Real-Time Toolkit  2.6.0
Public Types | Public Member Functions
RTT::base::BufferLocked< T > Class Template Reference

Implements a very simple blocking thread-safe buffer, using mutexes (locks). More...

#include <rtt/base/BufferLocked.hpp>

Inheritance diagram for RTT::base::BufferLocked< T >:
RTT::base::BufferInterface< T > RTT::base::BufferBase

List of all members.

Public Types

typedef BufferInterface< T >
::reference_t 
reference_t
typedef BufferInterface< T >
::param_t 
param_t
typedef BufferInterface< T >
::size_type 
size_type
typedef T value_t
typedef boost::shared_ptr
< BufferInterface< T > > 
shared_ptr

Public Member Functions

 BufferLocked (size_type size, const T &initial_value=T(), bool circular=false)
 Create a buffer of size size, with preallocated data storage.
virtual void data_sample (const T &sample)
 Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements.
virtual T data_sample () const
 Reads back a data sample.
 ~BufferLocked ()
 Destructor.
bool Push (param_t item)
 Write a single value to the buffer.
size_type Push (const std::vector< T > &items)
 Write a sequence of values to the buffer.
bool Pop (reference_t item)
 Read the oldest value from the buffer.
size_type Pop (std::vector< T > &items)
 Read the whole buffer.
value_t * PopWithoutRelease ()
 Returns a pointer to the first element in the buffer.
void Release (value_t *item)
 Releases the pointer.
size_type capacity () const
 Returns the maximum number of items that can be stored in the buffer.
size_type size () const
 Returns the actual number of items that are stored in the buffer.
void clear ()
 Clears all contents of this buffer.
bool empty () const
 Check if this buffer is empty.
bool full () const
 Check if this buffer is full.

Detailed Description

template<class T>
class RTT::base::BufferLocked< T >

Implements a very simple blocking thread-safe buffer, using mutexes (locks).

See also:
BufferLockFree

Definition at line 61 of file BufferLocked.hpp.


Constructor & Destructor Documentation

template<class T >
RTT::base::BufferLocked< T >::BufferLocked ( size_type  size,
const T &  initial_value = T(),
bool  circular = false 
) [inline]

Create a buffer of size size, with preallocated data storage.

Parameters:
sizeThe number of elements this buffer can hold.
initial_valueA data sample with which each preallocated data element is initialized.
circularSet flag to true to make this buffer circular. If not circular, new values are discarded on full.

Definition at line 77 of file BufferLocked.hpp.

References RTT::base::BufferLocked< T >::data_sample().


Member Function Documentation

template<class T >
size_type RTT::base::BufferLocked< T >::capacity ( ) const [inline, virtual]

Returns the maximum number of items that can be stored in the buffer.

Returns:
maximum number of items.

Implements RTT::base::BufferBase.

Definition at line 183 of file BufferLocked.hpp.

template<class T >
void RTT::base::BufferLocked< T >::clear ( ) [inline, virtual]

Clears all contents of this buffer.

Implements RTT::base::BufferBase.

Definition at line 193 of file BufferLocked.hpp.

template<class T >
virtual void RTT::base::BufferLocked< T >::data_sample ( const T &  sample) [inline, virtual]

Initializes this buffer with a data sample, such that for dynamical allocated types T, the buffer can reserve place to hold these elements.

Postcondition:
Calling this function causes all data in the buffer to be lost and the size being reset to zero.

Implements RTT::base::BufferInterface< T >.

Definition at line 83 of file BufferLocked.hpp.

template<class T >
bool RTT::base::BufferLocked< T >::empty ( ) const [inline, virtual]

Check if this buffer is empty.

Returns:
true if size() == 0

Implements RTT::base::BufferBase.

Definition at line 198 of file BufferLocked.hpp.

template<class T >
bool RTT::base::BufferLocked< T >::full ( ) const [inline, virtual]

Check if this buffer is full.

Returns:
true if size() == capacity()

Implements RTT::base::BufferBase.

Definition at line 203 of file BufferLocked.hpp.

template<class T >
bool RTT::base::BufferLocked< T >::Pop ( reference_t  item) [inline, virtual]

Read the oldest value from the buffer.

Parameters:
itemis to be set with a value from the buffer.
Returns:
true if something was read.

Implements RTT::base::BufferInterface< T >.

Definition at line 138 of file BufferLocked.hpp.

template<class T >
size_type RTT::base::BufferLocked< T >::Pop ( std::vector< T > &  items) [inline, virtual]

Read the whole buffer.

Parameters:
itemsis to be filled with all values in the buffer, with items.begin() the oldest value.
Returns:
the number of items read.

Implements RTT::base::BufferInterface< T >.

Definition at line 149 of file BufferLocked.hpp.

template<class T >
value_t* RTT::base::BufferLocked< T >::PopWithoutRelease ( ) [inline, virtual]

Returns a pointer to the first element in the buffer.

The pointer is only garanteed to stay valid until the next pop operation.

Note the pointer needs the be released by calling Release on the buffer.

Returns:
a pointer to a sample or Zero if buffer is empty

Implements RTT::base::BufferInterface< T >.

Definition at line 162 of file BufferLocked.hpp.

template<class T >
bool RTT::base::BufferLocked< T >::Push ( param_t  item) [inline, virtual]

Write a single value to the buffer.

Parameters:
itemthe value to write
Returns:
false if the buffer is full.

Implements RTT::base::BufferInterface< T >.

Definition at line 100 of file BufferLocked.hpp.

template<class T >
size_type RTT::base::BufferLocked< T >::Push ( const std::vector< T > &  items) [inline, virtual]

Write a sequence of values to the buffer.

Parameters:
itemsthe values to write
Returns:
the number of values written (may be less than items.size())

Implements RTT::base::BufferInterface< T >.

Definition at line 113 of file BufferLocked.hpp.

template<class T >
void RTT::base::BufferLocked< T >::Release ( value_t *  item) [inline, virtual]

Releases the pointer.

Parameters:
itempointer aquired using PopWithoutRelease()

Implements RTT::base::BufferInterface< T >.

Definition at line 176 of file BufferLocked.hpp.

template<class T >
size_type RTT::base::BufferLocked< T >::size ( ) const [inline, virtual]

Returns the actual number of items that are stored in the buffer.

Returns:
number of items.

Implements RTT::base::BufferBase.

Definition at line 188 of file BufferLocked.hpp.


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