Implements a not threadsafe buffer. More...
#include <rtt/base/BufferUnSync.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 | |
| BufferUnSync (size_type size, const T &initial_value=T(), bool circular=false) | |
| 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. | |
| virtual T | data_sample () const |
| Reads back a data sample. | |
| ~BufferUnSync () | |
| 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::BufferUnSync< T >
Implements a not threadsafe buffer.
Only use when no more than one thread accesses this buffer at a time.
- See also:
- BufferLockFree, BufferUnSync
Definition at line 58 of file BufferUnSync.hpp.
Member Function Documentation
| size_type RTT::base::BufferUnSync< 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 169 of file BufferUnSync.hpp.
| void RTT::base::BufferUnSync< T >::clear | ( | ) | [inline, virtual] |
Clears all contents of this buffer.
Implements RTT::base::BufferBase.
Definition at line 177 of file BufferUnSync.hpp.
| virtual void RTT::base::BufferUnSync< 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 76 of file BufferUnSync.hpp.
| bool RTT::base::BufferUnSync< T >::empty | ( | ) | const [inline, virtual] |
Check if this buffer is empty.
- Returns:
- true if size() == 0
Implements RTT::base::BufferBase.
Definition at line 181 of file BufferUnSync.hpp.
| bool RTT::base::BufferUnSync< T >::full | ( | ) | const [inline, virtual] |
Check if this buffer is full.
- Returns:
- true if size() == capacity()
Implements RTT::base::BufferBase.
Definition at line 185 of file BufferUnSync.hpp.
| bool RTT::base::BufferUnSync< T >::Pop | ( | reference_t | item | ) | [inline, virtual] |
Read the oldest value from the buffer.
- Parameters:
-
item is to be set with a value from the buffer.
- Returns:
- true if something was read.
Implements RTT::base::BufferInterface< T >.
Definition at line 125 of file BufferUnSync.hpp.
| size_type RTT::base::BufferUnSync< T >::Pop | ( | std::vector< T > & | items | ) | [inline, virtual] |
Read the whole buffer.
- Parameters:
-
items is 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 135 of file BufferUnSync.hpp.
| value_t* RTT::base::BufferUnSync< 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 147 of file BufferUnSync.hpp.
| bool RTT::base::BufferUnSync< T >::Push | ( | param_t | item | ) | [inline, virtual] |
Write a single value to the buffer.
- Parameters:
-
item the value to write
- Returns:
- false if the buffer is full.
Implements RTT::base::BufferInterface< T >.
Definition at line 92 of file BufferUnSync.hpp.
| size_type RTT::base::BufferUnSync< T >::Push | ( | const std::vector< T > & | items | ) | [inline, virtual] |
Write a sequence of values to the buffer.
- Parameters:
-
items the values to write
- Returns:
- the number of values written (may be less than items.size())
Implements RTT::base::BufferInterface< T >.
Definition at line 104 of file BufferUnSync.hpp.
| void RTT::base::BufferUnSync< T >::Release | ( | value_t * | item | ) | [inline, virtual] |
Releases the pointer.
- Parameters:
-
item pointer aquired using PopWithoutRelease()
Implements RTT::base::BufferInterface< T >.
Definition at line 162 of file BufferUnSync.hpp.
| size_type RTT::base::BufferUnSync< 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 173 of file BufferUnSync.hpp.
The documentation for this class was generated from the following file:
- rtt/base/BufferUnSync.hpp
