RTC::SyncFIFO< DataType > Class Template Reference

#include <SyncFIFO.h>

Inheritance diagram for RTC::SyncFIFO< DataType >:

RTC::BufferBase< DataType >

List of all members.

Public Member Functions

 SyncFIFO (int size=3)
virtual ~SyncFIFO ()
virtual void init (const DataType &data)
virtual void clear ()
virtual bool setBuffer (DataType *buffer, int size)
virtual DataType * unsetBuffer ()
virtual DataType * getBuffer () const
virtual long int length () const
 Get the buffer length.
virtual bool write (const DataType &data)
 Write data into the buffer.
virtual int writable ()
virtual void put (const DataType &data)
 Store data into the buffer.
virtual int putn (DataType *data, int size)
virtual void putNext (const DataType &data)
virtual bool isFull () const
 Check on whether the buffer is full.
virtual void pbump (int n)
virtual void overflow (const DataType &data)
virtual bool read (DataType &data)
 Read data from the buffer.
virtual int readable () const
virtual const DataType & get ()
 Get data from the buffer.
virtual void gbump (int n)
virtual const DataType & getNext ()
virtual int getn (DataType *data, int size)
virtual bool isEmpty () const
 Check on whether the buffer is empty.
virtual void underflow ()

Protected Member Functions

virtual DataType * wptr ()
virtual DataType * wnext ()
virtual DataType * wbegin ()
virtual DataType * wend ()
virtual DataType * rptr ()
virtual DataType * rnext ()
virtual DataType * rbegin ()
virtual DataType * rend ()

Protected Attributes

DataType * m_buffer
int m_size
DataType * m_buffer_org
int m_size_org
int m_wpos
int m_wnext
int m_rpos
int m_rnext
int & m_wbegin
int & m_wend
int & m_rbegin
int & m_rend

template<class DataType>
class RTC::SyncFIFO< DataType >


Constructor & Destructor Documentation

template<class DataType>
RTC::SyncFIFO< DataType >::SyncFIFO ( int  size = 3  )  [inline]

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


Member Function Documentation

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::init ( const DataType &  data  )  [inline, virtual]

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::clear (  )  [inline, virtual]

template<class DataType>
virtual bool RTC::SyncFIFO< DataType >::setBuffer ( DataType *  buffer,
int  size 
) [inline, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::unsetBuffer (  )  [inline, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::getBuffer (  )  const [inline, virtual]

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

Get the buffer length.

Pure virtual function to get the buffer length.

Returns:
buffer length

Implements RTC::BufferBase< DataType >.

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

Write data into the buffer.

Pure virtual function to write data into the buffer.

Parameters:
value Target data to write.
Returns:
Result of having written in data (true:Successful, false:Failed)

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual int RTC::SyncFIFO< DataType >::writable (  )  [inline, virtual]

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

Store data into the buffer.

Pure virtual function to store data into the buffer.

Parameters:
data Target data

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual int RTC::SyncFIFO< DataType >::putn ( DataType *  data,
int  size 
) [inline, virtual]

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::putNext ( const DataType &  data  )  [inline, virtual]

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

Check on whether the buffer is full.

Pure virtual function to check on whether the buffer is full.

Returns:
True if the buffer is full, else false.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::pbump ( int  n  )  [inline, virtual]

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::overflow ( const DataType &  data  )  [inline, virtual]

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

Read data from the buffer.

Pure virtual function to read data from the buffer.

Parameters:
value Read data.
Returns:
Result of having read (true:Successful, false:Failed)

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual int RTC::SyncFIFO< DataType >::readable (  )  const [inline, virtual]

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

Get data from the buffer.

Pure virtual function to get data from the buffer.

Returns:
Data got from buffer.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::gbump ( int  n  )  [inline, virtual]

template<class DataType>
virtual const DataType& RTC::SyncFIFO< DataType >::getNext (  )  [inline, virtual]

template<class DataType>
virtual int RTC::SyncFIFO< DataType >::getn ( DataType *  data,
int  size 
) [inline, virtual]

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

Check on whether the buffer is empty.

Pure virtual function to check on whether the buffer is empty.

Returns:
True if the buffer is empty, else false.

Implements RTC::BufferBase< DataType >.

template<class DataType>
virtual void RTC::SyncFIFO< DataType >::underflow (  )  [inline, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::wptr (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::wnext (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::wbegin (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::wend (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::rptr (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::rnext (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::rbegin (  )  [inline, protected, virtual]

template<class DataType>
virtual DataType* RTC::SyncFIFO< DataType >::rend (  )  [inline, protected, virtual]


Member Data Documentation

template<class DataType>
DataType* RTC::SyncFIFO< DataType >::m_buffer [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_size [protected]

template<class DataType>
DataType* RTC::SyncFIFO< DataType >::m_buffer_org [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_size_org [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_wpos [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_wnext [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_rpos [protected]

template<class DataType>
int RTC::SyncFIFO< DataType >::m_rnext [protected]

template<class DataType>
int& RTC::SyncFIFO< DataType >::m_wbegin [protected]

template<class DataType>
int & RTC::SyncFIFO< DataType >::m_wend [protected]

template<class DataType>
int& RTC::SyncFIFO< DataType >::m_rbegin [protected]

template<class DataType>
int & RTC::SyncFIFO< DataType >::m_rend [protected]


Generated on Thu May 29 15:03:33 2008 for OpenRTM by  doxygen 1.5.3