Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTC::BufferBase< DataType > Class Template Reference

BufferBase abstract class. More...

#include <BufferBase.h>

Inheritance diagram for RTC::BufferBase< DataType >:

RTC::NullBuffer< DataType > RTC::RingBuffer< DataType > List of all members.

Public Member Functions

virtual ~BufferBase ()
 virtual destractor
virtual long int length () const =0
 Get the buffer length.
virtual bool write (const DataType &value)=0
 Write data into the buffer.
virtual bool read (DataType &value)=0
 Write data into the buffer.
virtual bool isFull () const =0
 True if the buffer is full, else false.
virtual bool isEmpty () const =0
 True if the buffer is empty, else false.

Protected Member Functions

virtual void put (const DataType &data)=0
 Write data into the buffer.
virtual const DataType & get ()=0
 Get data from the buffer.
virtual DataType & getRef ()=0
 Get the buffer's reference to be written the next.

Detailed Description

template<class DataType>
class RTC::BufferBase< DataType >

BufferBase abstract class.

This is the abstract interface class for various Buffer.

Parameters:
DataType Data type to be stored to the buffer.


Constructor & Destructor Documentation

template<class DataType>
virtual RTC::BufferBase< DataType >::~BufferBase  )  [inline, virtual]
 

virtual destractor


Member Function Documentation

template<class DataType>
virtual const DataType& RTC::BufferBase< DataType >::get  )  [protected, pure virtual]
 

Get data from the buffer.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual DataType& RTC::BufferBase< DataType >::getRef  )  [protected, pure virtual]
 

Get the buffer's reference to be written the next.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual bool RTC::BufferBase< DataType >::isEmpty  )  const [pure virtual]
 

True if the buffer is empty, else false.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual bool RTC::BufferBase< DataType >::isFull  )  const [pure virtual]
 

True if the buffer is full, else false.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual long int RTC::BufferBase< DataType >::length  )  const [pure virtual]
 

Get the buffer length.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual void RTC::BufferBase< DataType >::put const DataType &  data  )  [protected, pure virtual]
 

Write data into the buffer.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual bool RTC::BufferBase< DataType >::read DataType &  value  )  [pure virtual]
 

Write data into the buffer.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.

template<class DataType>
virtual bool RTC::BufferBase< DataType >::write const DataType &  value  )  [pure virtual]
 

Write data into the buffer.

Implemented in RTC::NullBuffer< DataType >, and RTC::RingBuffer< DataType >.


The documentation for this class was generated from the following file:
Generated on Fri Oct 5 05:16:02 2007 for OpenRTM by  doxygen 1.4.1