#include <OutPortConsumer.h>
Public Member Functions | |
virtual DATAPORTSTATUS_ENUM | ~OutPortConsumer (void) |
Destructor. | |
virtual void | init (coil::Properties &prop)=0 |
Initializing configuration. | |
virtual void | setBuffer (CdrBufferBase *buffer)=0 |
Setting outside buffer's pointer. | |
virtual void | setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0 |
Set the listener. | |
virtual ReturnCode | get (cdrMemoryStream &data)=0 |
Receive data. | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties)=0 |
Subscribe the data receive notification. | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties)=0 |
Unsubscribe the data receive notification. | |
Protected Attributes | |
Logger | rtclog |
Logger stream. | |
Classes | |
struct | subscribe |
Functor to subscribe the interface. More... | |
struct | unsubscribe |
Functor to unsubscribe the interface. More... |
This is the abstract interface class for the output port Consumer. Concrete classes must implement the following pure virtual functions.
virtual DATAPORTSTATUS_ENUM RTC::OutPortConsumer::~OutPortConsumer | ( | void | ) | [inline, virtual] |
Destructor.
Destructor
virtual void RTC::OutPortConsumer::init | ( | coil::Properties & | prop | ) | [pure virtual] |
Initializing configuration.
This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.
prop | Configuration information |
Implemented in RTC::OutPortCorbaCdrConsumer.
virtual void RTC::OutPortConsumer::setBuffer | ( | CdrBufferBase * | buffer | ) | [pure virtual] |
Setting outside buffer's pointer.
A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.
buffer | A pointer to a data buffer to be used by OutPortProvider |
Implemented in RTC::OutPortCorbaCdrConsumer.
virtual void RTC::OutPortConsumer::setListener | ( | ConnectorInfo & | info, | |
ConnectorListeners * | listeners | |||
) | [pure virtual] |
virtual ReturnCode RTC::OutPortConsumer::get | ( | cdrMemoryStream & | data | ) | [pure virtual] |
virtual bool RTC::OutPortConsumer::subscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [pure virtual] |
Subscribe the data receive notification.
Pure virtual function to subscribe the data receive notification based on specified property information.
properties | Properties for subscription |
Implemented in RTC::OutPortCorbaCdrConsumer.
Referenced by RTC::OutPortConsumer::subscribe::operator()().
virtual void RTC::OutPortConsumer::unsubscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [pure virtual] |
Unsubscribe the data receive notification.
Pure virtual function to unsubscribe the data receive notification.
properties | Properties for unsubscription |
Implemented in RTC::OutPortCorbaCdrConsumer.
Referenced by RTC::OutPortConsumer::unsubscribe::operator()().
Logger RTC::OutPortConsumer::rtclog [mutable, protected] |
Logger stream.