Public Types | Public Member Functions
RTT::base::BufferBase Class Reference

#include <BufferBase.hpp>

Inheritance diagram for RTT::base::BufferBase:
Inheritance graph
[legend]

List of all members.

Public Types

typedef boost::shared_ptr
< BufferBase
shared_ptr
typedef int size_type

Public Member Functions

virtual size_type capacity () const =0
virtual void clear ()=0
virtual bool empty () const =0
virtual bool full () const =0
virtual size_type size () const =0
virtual ~BufferBase ()

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 Typedef Documentation

typedef boost::shared_ptr< BufferBase > RTT::base::BufferBase::shared_ptr

Reimplemented in RTT::base::BufferInterface< T >.

Definition at line 57 of file BufferBase.hpp.


Constructor & Destructor Documentation

BufferBase::~BufferBase ( ) [virtual]

Definition at line 44 of file BufferBase.cpp.


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]

Clears all contents of this buffer.

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

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:


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:43