Orocos Real-Time Toolkit
2.5.0
|
Implements a very simple blocking thread-safe buffer, using mutexes (locks). More...
#include <rtt/base/BufferLocked.hpp>
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()) | |
Create a buffer of size size. | |
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. | |
~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. |
Implements a very simple blocking thread-safe buffer, using mutexes (locks).
Definition at line 61 of file BufferLocked.hpp.
size_type RTT::base::BufferLocked< T >::capacity | ( | ) | const [inline, virtual] |
Returns the maximum number of items that can be stored in the buffer.
Implements RTT::base::BufferBase.
Definition at line 156 of file BufferLocked.hpp.
void RTT::base::BufferLocked< T >::clear | ( | ) | [inline, virtual] |
Clears all contents of this buffer.
Implements RTT::base::BufferBase.
Definition at line 166 of file BufferLocked.hpp.
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.
Implements RTT::base::BufferInterface< T >.
Definition at line 80 of file BufferLocked.hpp.
Referenced by RTT::base::BufferLocked< T >::BufferLocked().
bool RTT::base::BufferLocked< T >::empty | ( | ) | const [inline, virtual] |
Check if this buffer is empty.
Implements RTT::base::BufferBase.
Definition at line 171 of file BufferLocked.hpp.
bool RTT::base::BufferLocked< T >::full | ( | ) | const [inline, virtual] |
Check if this buffer is full.
Implements RTT::base::BufferBase.
Definition at line 176 of file BufferLocked.hpp.
bool RTT::base::BufferLocked< T >::Pop | ( | reference_t | item | ) | [inline, virtual] |
Read the oldest value from the buffer.
item | is to be set with a value from the buffer. |
Implements RTT::base::BufferInterface< T >.
Definition at line 112 of file BufferLocked.hpp.
size_type RTT::base::BufferLocked< T >::Pop | ( | std::vector< T > & | items | ) | [inline, virtual] |
Read the whole buffer.
items | is to be filled with all values in the buffer, with items.begin() the oldest value. |
Implements RTT::base::BufferInterface< T >.
Definition at line 123 of file BufferLocked.hpp.
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.
Implements RTT::base::BufferInterface< T >.
Definition at line 135 of file BufferLocked.hpp.
bool RTT::base::BufferLocked< T >::Push | ( | param_t | item | ) | [inline, virtual] |
Write a single value to the buffer.
item | the value to write |
Implements RTT::base::BufferInterface< T >.
Definition at line 91 of file BufferLocked.hpp.
size_type RTT::base::BufferLocked< T >::Push | ( | const std::vector< T > & | items | ) | [inline, virtual] |
Write a sequence of values to the buffer.
items | the values to write |
Implements RTT::base::BufferInterface< T >.
Definition at line 101 of file BufferLocked.hpp.
void RTT::base::BufferLocked< T >::Release | ( | value_t * | item | ) | [inline, virtual] |
Releases the pointer.
item | pointer aquired using PopWithoutRelease() |
Implements RTT::base::BufferInterface< T >.
Definition at line 149 of file BufferLocked.hpp.
size_type RTT::base::BufferLocked< T >::size | ( | ) | const [inline, virtual] |
Returns the actual number of items that are stored in the buffer.
Implements RTT::base::BufferBase.
Definition at line 161 of file BufferLocked.hpp.