OpenRTM-aist  1.2.1
Public Member Functions | List of all members
RTC::OnReadConvert< DataType > Class Template Referenceabstract

Data convert callback abstract class on read() More...

#include <PortCallback.h>

Public Member Functions

virtual ~OnReadConvert (void)
 Destructor. More...
 
virtual DataType & operator() (DataType &value)=0
 Callback method. More...
 

Detailed Description

template<class DataType>
class RTC::OnReadConvert< DataType >

Data convert callback abstract class on read()

This is the interface for callback invoked when data is done read() from the InPort/OutPort's buffer. The return value of this callback will be the return value of read().

Since
0.4.0

Constructor & Destructor Documentation

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

Destructor.

Destructor

References RTC::ConnectionCallback::operator()().

Member Function Documentation

template<class DataType>
virtual DataType& RTC::OnReadConvert< DataType >::operator() ( DataType &  value)
pure virtual

Callback method.

This function is the callback function invoked when data is readout from the buffer, and the return value of operator()() is used as return value of InPort's read() or it is stored in the InPort data variable.

Parameters
valueData that is readout from buffer
Returns
Converted data. These data are stored in the port's variable.

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