Public Member Functions | List of all members
RTC::BufferBase< DataType > Class Template Referenceabstract

BufferBase abstract class. More...

#include <BufferBase.h>

Inheritance diagram for RTC::BufferBase< DataType >:
Inheritance graph
[legend]

Public Member Functions

virtual ReturnCode advanceRptr (long int n=1)=0
 Forward n reading pointers. More...
 
virtual ReturnCode advanceWptr (long int n=1)=0
 Forward n writing pointers. More...
 
virtual bool empty (void) const =0
 Check on whether the buffer is empty. More...
 
virtual bool full (void) const =0
 Check on whether the buffer is full. More...
 
virtual ReturnCode get (DataType &value)=0
 Read data from the buffer. More...
 
virtual DataType & get ()=0
 Read data from the buffer. More...
 
virtual void init (const coil::Properties &prop)=0
 Set the buffer. More...
 
virtual size_t length (void) const =0
 Get the buffer length. More...
 
virtual ReturnCode length (size_t n)=0
 Set the buffer length. More...
 
virtual ReturnCode put (const DataType &value)=0
 Write data into the buffer. More...
 
virtual ReturnCode read (DataType &value, long int sec=-1, long int nsec=-1)=0
 Read data from the buffer. More...
 
virtual size_t readable () const =0
 Write data into the buffer. More...
 
virtual ReturnCode reset ()=0
 Reset the buffer status. More...
 
virtual DataType * rptr (long int n=0)=0
 Get the reading pointer. More...
 
virtual DataType * wptr (long int n=0)=0
 Get the writing pointer. More...
 
virtual size_t writable () const =0
 Get a writable number. More...
 
virtual ReturnCode write (const DataType &value, long int sec=-1, long int nsec=-1)=0
 Write data into the buffer. More...
 
virtual BUFFERSTATUS_ENUM ~BufferBase (void)
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from RTC::BufferStatus
enum  Enum {
  BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY,
  NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET
}
 DataPortStatus return codes. More...
 
- Static Public Member Functions inherited from RTC::BufferStatus
static const char * toString (Enum status)
 Convert BufferStatus into the string. More...
 

Detailed Description

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

BufferBase abstract class.

This is the abstract interface class for various Buffer. Concrete buffer classes must implement the following pure virtual functions. The users specify data type to hold it in a buffer as <DataType>.

This class provides public interface as follows.

This class provides protected interface as follows.

Parameters
DataTypeData type to be stored to the buffer.
Since
0.4.0

Definition at line 104 of file BufferBase.h.

Constructor & Destructor Documentation

template<class DataType>
virtual BUFFERSTATUS_ENUM RTC::BufferBase< DataType >::~BufferBase ( void  )
inlinevirtual

Virtual destructor.

Definition at line 121 of file BufferBase.h.

Member Function Documentation

template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::advanceRptr ( long int  n = 1)
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::advanceWptr ( long int  n = 1)
pure virtual
template<class DataType>
virtual bool RTC::BufferBase< DataType >::empty ( void  ) const
pure virtual
template<class DataType>
virtual bool RTC::BufferBase< DataType >::full ( void  ) const
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::get ( DataType &  value)
pure virtual
template<class DataType>
virtual DataType& RTC::BufferBase< DataType >::get ( )
pure virtual
template<class DataType>
virtual void RTC::BufferBase< DataType >::init ( const coil::Properties prop)
pure virtual
template<class DataType>
virtual size_t RTC::BufferBase< DataType >::length ( void  ) const
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::length ( size_t  n)
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::put ( const DataType &  value)
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::read ( DataType &  value,
long int  sec = -1,
long int  nsec = -1 
)
pure virtual
template<class DataType>
virtual size_t RTC::BufferBase< DataType >::readable ( ) const
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::reset ( )
pure virtual
template<class DataType>
virtual DataType* RTC::BufferBase< DataType >::rptr ( long int  n = 0)
pure virtual
template<class DataType>
virtual DataType* RTC::BufferBase< DataType >::wptr ( long int  n = 0)
pure virtual
template<class DataType>
virtual size_t RTC::BufferBase< DataType >::writable ( ) const
pure virtual
template<class DataType>
virtual ReturnCode RTC::BufferBase< DataType >::write ( const DataType &  value,
long int  sec = -1,
long int  nsec = -1 
)
pure virtual

The documentation for this class was generated from the following file:


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Jun 6 2019 19:26:03