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

RTC::RingBuffer< DataType > Class Template Reference

#include <RingBuffer.h>

Inheritance diagram for RTC::RingBuffer< DataType >:

RTC::BufferBase< DataType > List of all members.

Public Member Functions

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

Protected Member Functions

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

Classes

class  Data
 Buffer sequence.

template<class DataType>
class RTC::RingBuffer< DataType >


Constructor & Destructor Documentation

template<class DataType>
RTC::RingBuffer< DataType >::RingBuffer long int  length  )  [inline]
 

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

virtual destractor


Member Function Documentation

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

Get data from the buffer.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual DataType& RTC::RingBuffer< DataType >::getRef  )  [inline, protected, virtual]
 

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

Implements RTC::BufferBase< DataType >.

template<class DataType>
void RTC::RingBuffer< DataType >::init DataType &  data  )  [inline]
 

template<class DataType>
virtual bool RTC::RingBuffer< DataType >::isEmpty  )  const [inline, virtual]
 

True if the buffer is empty, else false.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual bool RTC::RingBuffer< DataType >::isFull  )  const [inline, virtual]
 

True if the buffer is full, else false.

Implements RTC::BufferBase< DataType >.

template<class DataType>
bool RTC::RingBuffer< DataType >::isNew  )  const [inline]
 

template<class DataType>
virtual long int RTC::RingBuffer< DataType >::length  )  const [inline, virtual]
 

Get the buffer length.

Implements RTC::BufferBase< DataType >.

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

Write data into the buffer.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual bool RTC::RingBuffer< DataType >::read DataType &  value  )  [inline, virtual]
 

Write data into the buffer.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual bool RTC::RingBuffer< DataType >::write const DataType &  value  )  [inline, virtual]
 

Write data into the buffer.

Implements RTC::BufferBase< DataType >.


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