This object represents the default Multi-Writer/Multi-Reader queue implementation used by Orocos objects. More...
#include <rtt/internal/Queue.hpp>
Inheritance diagram for RTT::internal::Queue< T >:
Public Types | |
| typedef unsigned int | size_type |
Public Member Functions | |
| Queue (int qsize) | |
| Create a mw/sr queue of fixed size. | |
| bool | isFull () const |
| Inspect if the Queue is full. | |
| bool | isEmpty () const |
| Inspect if the Queue is empty. | |
| size_type | capacity () const |
| Return the maximum number of items this queue can contain. | |
| size_type | size () const |
| Return the exact number of elements in the queue. | |
| bool | enqueue (const T &value) |
| Enqueue an item. | |
| bool | dequeue (T &result) |
| Dequeue an item. | |
| const T | front () const |
| Return the next to be read value. | |
| void | clear () |
| Clear all contents of the Queue and thus make it empty. | |
Detailed Description
template<class T>
class RTT::internal::Queue< T >
This object represents the default Multi-Writer/Multi-Reader queue implementation used by Orocos objects.
Member Function Documentation
template<class T >
| bool RTT::internal::AtomicQueue< T >::dequeue | ( | T & | result | ) | [inline, inherited] |
Dequeue an item.
- Parameters:
-
value The value dequeued.
- Returns:
- false if queue is empty, true if dequeued.
Definition at line 278 of file AtomicQueue.hpp.
References RTT::os::CAS().
template<class T >
| bool RTT::internal::AtomicQueue< T >::enqueue | ( | const T & | value | ) | [inline, inherited] |
Enqueue an item.
- Parameters:
-
value The value to enqueue, not zero.
- Returns:
- false if queue is full or value is zero, true if queued.
Definition at line 258 of file AtomicQueue.hpp.
References RTT::os::CAS().
template<class T >
| bool RTT::internal::AtomicQueue< T >::isEmpty | ( | ) | const [inline, inherited] |
Inspect if the Queue is empty.
- Returns:
- true if empty, false otherwise.
Definition at line 220 of file AtomicQueue.hpp.
template<class T >
| bool RTT::internal::AtomicQueue< T >::isFull | ( | ) | const [inline, inherited] |
Inspect if the Queue is full.
- Returns:
- true if full, false otherwise.
Definition at line 206 of file AtomicQueue.hpp.
template<class T >
| size_type RTT::internal::AtomicQueue< T >::size | ( | ) | const [inline, inherited] |
Return the exact number of elements in the queue.
This is slow because it scans the whole queue.
Definition at line 241 of file AtomicQueue.hpp.
The documentation for this class was generated from the following file:
- rtt/internal/Queue.hpp
