OutPortCorbaCdrConsumer class. More...
#include <OutPortCorbaCdrConsumer.h>
Public Member Functions | |
virtual ReturnCode | get (cdrMemoryStream &data) |
Read data. | |
virtual void | init (coil::Properties &prop) |
Initializing configuration. | |
DATAPORTSTATUS_ENUM | OutPortCorbaCdrConsumer () |
Constructor. | |
virtual void | setBuffer (CdrBufferBase *buffer) |
Setting outside buffer's pointer. | |
virtual void | setListener (ConnectorInfo &info, ConnectorListeners *listeners) |
Set the listener. | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties) |
Subscribe the data receive notification. | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties) |
Unsubscribe the data receive notification. | |
virtual | ~OutPortCorbaCdrConsumer (void) |
Destructor. | |
Private Member Functions | |
OutPortConsumer::ReturnCode | convertReturn (::OpenRTM::PortStatus status, const cdrMemoryStream &data) |
Return codes conversion. | |
void | onBufferFull (const cdrMemoryStream &data) |
Notify an ON_BUFFER_FULL event to listeners. | |
void | onBufferWrite (const cdrMemoryStream &data) |
Notify an ON_BUFFER_WRITE event to listeners. | |
void | onReceived (const cdrMemoryStream &data) |
Notify an ON_RECEIVED event to listeners. | |
void | onReceiverFull (const cdrMemoryStream &data) |
Notify an ON_RECEIVER_FULL event to listeners. | |
void | onSenderEmpty () |
Notify an ON_SENDER_EMPTY event to listeners. | |
void | onSenderError () |
void | onSenderTimeout () |
Notify an ON_SENDER_TIMEOUT event to listeners. | |
Private Attributes | |
CdrBufferBase * | m_buffer |
ConnectorListeners * | m_listeners |
ConnectorInfo | m_profile |
OutPortCorbaCdrConsumer class.
The OutPort consumer class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a pull-type dataflow.
Definition at line 55 of file OutPortCorbaCdrConsumer.h.
RTC::OutPortCorbaCdrConsumer::~OutPortCorbaCdrConsumer | ( | void | ) | [virtual] |
OutPortConsumer::ReturnCode RTC::OutPortCorbaCdrConsumer::convertReturn | ( | ::OpenRTM::PortStatus | status, |
const cdrMemoryStream & | data | ||
) | [private] |
Return codes conversion.
Definition at line 226 of file OutPortCorbaCdrConsumer.cpp.
OutPortConsumer::ReturnCode RTC::OutPortCorbaCdrConsumer::get | ( | cdrMemoryStream & | data | ) | [virtual] |
Read data.
Read set data
data | Object to receive the read data |
Implements RTC::OutPortConsumer.
Definition at line 97 of file OutPortCorbaCdrConsumer.cpp.
void RTC::OutPortCorbaCdrConsumer::init | ( | coil::Properties & | prop | ) | [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 |
Implements RTC::OutPortConsumer.
Definition at line 56 of file OutPortCorbaCdrConsumer.cpp.
void RTC::OutPortCorbaCdrConsumer::onBufferFull | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_FULL event to listeners.
data | cdrMemoryStream |
Definition at line 296 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onBufferWrite | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_WRITE event to listeners.
data | cdrMemoryStream |
Definition at line 281 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onReceived | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVED event to listeners.
data | cdrMemoryStream |
Definition at line 311 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onReceiverFull | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVER_FULL event to listeners.
data | cdrMemoryStream |
Definition at line 326 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onSenderEmpty | ( | ) | [inline, private] |
Notify an ON_SENDER_EMPTY event to listeners.
Definition at line 339 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onSenderError | ( | ) | [inline, private] |
Notify an ON_SENDER_ERROR event to listeners
Definition at line 365 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::onSenderTimeout | ( | ) | [inline, private] |
Notify an ON_SENDER_TIMEOUT event to listeners.
Definition at line 352 of file OutPortCorbaCdrConsumer.h.
void RTC::OutPortCorbaCdrConsumer::setBuffer | ( | CdrBufferBase * | buffer | ) | [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 |
Implements RTC::OutPortConsumer.
Definition at line 68 of file OutPortCorbaCdrConsumer.cpp.
void RTC::OutPortCorbaCdrConsumer::setListener | ( | ConnectorInfo & | info, |
ConnectorListeners * | listeners | ||
) | [virtual] |
Set the listener.
OutPort provides callback functionality that calls specific listener objects according to the events in the data publishing process. For details, see documentation of ConnectorDataListener class and ConnectorListener class in ConnectorListener.h. In this OutPortCorbaCdrProvider provides the following callbacks.
info | Connector information |
listeners | Listener objects |
Implements RTC::OutPortConsumer.
Definition at line 81 of file OutPortCorbaCdrConsumer.cpp.
bool RTC::OutPortCorbaCdrConsumer::subscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [virtual] |
Subscribe the data receive notification.
Subscribe the data receive notification based on specified property information
properties | Subscription information |
Implements RTC::OutPortConsumer.
Definition at line 146 of file OutPortCorbaCdrConsumer.cpp.
void RTC::OutPortCorbaCdrConsumer::unsubscribeInterface | ( | const SDOPackage::NVList & | properties | ) | [virtual] |
Unsubscribe the data receive notification.
Unsubscribe the data receive notification.
properties | Unsubscription information |
Implements RTC::OutPortConsumer.
Definition at line 190 of file OutPortCorbaCdrConsumer.cpp.
Definition at line 372 of file OutPortCorbaCdrConsumer.h.
Definition at line 373 of file OutPortCorbaCdrConsumer.h.
Definition at line 374 of file OutPortCorbaCdrConsumer.h.