Orocos Real-Time Toolkit  2.5.0
Public Types | Public Member Functions
RTT::base::BufferBase Class Reference

Any Buffer has a capacity, size and can be empty or full. More...

#include <rtt/base/BufferBase.hpp>

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

List of all members.

Public Types

typedef int size_type
typedef boost::shared_ptr
< BufferBase
shared_ptr

Public Member Functions

virtual size_type capacity () const =0
 Returns the maximum number of items that can be stored in the buffer.
virtual size_type size () const =0
 Returns the actual number of items that are stored in the buffer.
virtual bool empty () const =0
 Check if this buffer is empty.
virtual bool full () const =0
 Check if this buffer is full.
virtual void clear ()=0
 Clears all contents of this buffer.

Detailed Description

Any Buffer has a capacity, size and can be empty or full.

This class contains the type-independent methods of a Buffer.

Definition at line 52 of file BufferBase.hpp.


Member Function Documentation

virtual size_type RTT::base::BufferBase::capacity ( ) const [pure virtual]

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

Returns:
maximum number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferUnSync< T >, and RTT::base::BufferLockFree< T >.

virtual void RTT::base::BufferBase::clear ( ) [pure virtual]
virtual bool RTT::base::BufferBase::empty ( ) const [pure virtual]

Check if this buffer is empty.

Returns:
true if size() == 0

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferUnSync< T >, and RTT::base::BufferLockFree< T >.

virtual bool RTT::base::BufferBase::full ( ) const [pure virtual]

Check if this buffer is full.

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

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferUnSync< T >, and RTT::base::BufferLockFree< T >.

virtual size_type RTT::base::BufferBase::size ( ) const [pure virtual]

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

Returns:
number of items.

Implemented in RTT::base::BufferLocked< T >, RTT::base::BufferUnSync< T >, and RTT::base::BufferLockFree< T >.


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