RTT::BufferBase Class Reference

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

#include <rtt/BufferBase.hpp>

Inheritance diagram for RTT::BufferBase:
RTT::ReadInterface< T > RTT::WriteInterface< T > RTT::BufferInterface< T > RTT::BufferInterface< T > RTT::BufferLocked< T, ReadPolicy, WritePolicy > RTT::BufferLockFree< T, ReadPolicy, WritePolicy > RTT::Corba::CorbaBufferProxy< T > RTT::BufferLocked< T, ReadPolicy, WritePolicy > RTT::BufferLockFree< T, ReadPolicy, WritePolicy > RTT::Corba::CorbaBufferProxy< T > RTT::Buffer< T, ReadPolicy, WritePolicy > RTT::Buffer< T, ReadPolicy, WritePolicy >

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 50 of file BufferBase.hpp.


Member Function Documentation

virtual size_type RTT::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::BufferLocked< T, ReadPolicy, WritePolicy >, RTT::BufferLockFree< T, ReadPolicy, WritePolicy >, and RTT::Corba::CorbaBufferProxy< T >.

virtual bool RTT::BufferBase::empty (  )  const [pure virtual]
virtual bool RTT::BufferBase::full (  )  const [pure virtual]
virtual size_type RTT::BufferBase::size (  )  const [pure virtual]

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

Returns:
number of items.

Implemented in RTT::BufferLocked< T, ReadPolicy, WritePolicy >, RTT::BufferLockFree< T, ReadPolicy, WritePolicy >, and RTT::Corba::CorbaBufferProxy< T >.


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:22:39 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3