InPortCorbaCdrProvider class. More...
#include <InPortCorbaCdrProvider.h>
Public Member Functions | |
virtual void | init (coil::Properties &prop) |
Initializing configuration. | |
InPortCorbaCdrProvider (void) | |
Constructor. | |
virtual ::OpenRTM::PortStatus | put (const ::OpenRTM::CdrData &data) throw (CORBA::SystemException) |
[CORBA interface] Write data into the buffer | |
virtual void | setBuffer (BufferBase< cdrMemoryStream > *buffer) |
Setting outside buffer's pointer. | |
virtual void | setConnector (InPortConnector *connector) |
set Connector | |
virtual void | setListener (ConnectorInfo &info, ConnectorListeners *listeners) |
Set the listener. | |
virtual | ~InPortCorbaCdrProvider (void) |
Destructor. | |
Private Member Functions | |
::OpenRTM::PortStatus | convertReturn (BufferStatus::Enum 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 | onBufferWriteOverwrite (const cdrMemoryStream &data) |
Notify an ON_BUFFER_WRITE_OVERWRITE event to listeners. | |
void | onBufferWriteTimeout (const cdrMemoryStream &data) |
Notify an ON_BUFFER_WRITE_TIMEOUT event to listeners. | |
void | onReceived (const cdrMemoryStream &data) |
Notify an ON_RECEIVED event to listeners. | |
void | onReceiverError (const cdrMemoryStream &data) |
void | onReceiverFull (const cdrMemoryStream &data) |
Notify an ON_RECEIVER_FULL event to listeners. | |
void | onReceiverTimeout (const cdrMemoryStream &data) |
Notify an ON_RECEIVER_TIMEOUT event to listeners. | |
Private Attributes | |
CdrBufferBase * | m_buffer |
InPortConnector * | m_connector |
ConnectorListeners * | m_listeners |
::OpenRTM::InPortCdr_var | m_objref |
ConnectorInfo | m_profile |
InPortCorbaCdrProvider class.
The InPort provider class which uses the OpenRTM::InPortCdr interface in CORBA for data transfer and realizes a push-type dataflow.
Definition at line 61 of file InPortCorbaCdrProvider.h.
RTC::InPortCorbaCdrProvider::~InPortCorbaCdrProvider | ( | void | ) | [virtual] |
OpenRTM::PortStatus RTC::InPortCorbaCdrProvider::convertReturn | ( | BufferStatus::Enum | status, |
const cdrMemoryStream & | data | ||
) | [private] |
Return codes conversion.
Definition at line 172 of file InPortCorbaCdrProvider.cpp.
void RTC::InPortCorbaCdrProvider::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::InPortProvider.
Definition at line 85 of file InPortCorbaCdrProvider.cpp.
void RTC::InPortCorbaCdrProvider::onBufferFull | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_FULL event to listeners.
data | cdrMemoryStream |
Definition at line 287 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onBufferWrite | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_WRITE event to listeners.
data | cdrMemoryStream |
Definition at line 272 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onBufferWriteOverwrite | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_WRITE_OVERWRITE event to listeners.
data | cdrMemoryStream |
Definition at line 317 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onBufferWriteTimeout | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_BUFFER_WRITE_TIMEOUT event to listeners.
data | cdrMemoryStream |
Definition at line 302 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onReceived | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVED event to listeners.
data | cdrMemoryStream |
Definition at line 332 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onReceiverError | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVER_ERROR event to listeners
Definition at line 373 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onReceiverFull | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVER_FULL event to listeners.
data | cdrMemoryStream |
Definition at line 347 of file InPortCorbaCdrProvider.h.
void RTC::InPortCorbaCdrProvider::onReceiverTimeout | ( | const cdrMemoryStream & | data | ) | [inline, private] |
Notify an ON_RECEIVER_TIMEOUT event to listeners.
Definition at line 360 of file InPortCorbaCdrProvider.h.
OpenRTM::PortStatus RTC::InPortCorbaCdrProvider::put | ( | const ::OpenRTM::CdrData & | data | ) | throw (CORBA::SystemException) |
[CORBA interface] Write data into the buffer
Write data into the buffer.
Write data into the specified buffer.
data | The target data for writing |
Definition at line 136 of file InPortCorbaCdrProvider.cpp.
void RTC::InPortCorbaCdrProvider::setBuffer | ( | BufferBase< cdrMemoryStream > * | 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::InPortProvider.
Definition at line 97 of file InPortCorbaCdrProvider.cpp.
void RTC::InPortCorbaCdrProvider::setConnector | ( | InPortConnector * | connector | ) | [virtual] |
set Connector
InPort creates InPortConnector object when it establishes connection between InPort and InPort, and it calls this function with a pointer to the connector object. Since the InPort has the ownership of this connector, InPortProvider should not delete it.
connector | InPortConnector |
Implements RTC::InPortProvider.
Definition at line 123 of file InPortCorbaCdrProvider.cpp.
void RTC::InPortCorbaCdrProvider::setListener | ( | ConnectorInfo & | info, |
ConnectorListeners * | listeners | ||
) | [virtual] |
Set the listener.
InPort 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 InPortCorbaCdrProvider provides the following callbacks.
info | Connector information |
listeners | Listener objects |
Implements RTC::InPortProvider.
Definition at line 109 of file InPortCorbaCdrProvider.cpp.
Definition at line 380 of file InPortCorbaCdrProvider.h.
Definition at line 384 of file InPortCorbaCdrProvider.h.
Definition at line 382 of file InPortCorbaCdrProvider.h.
::OpenRTM::InPortCdr_var RTC::InPortCorbaCdrProvider::m_objref [private] |
Definition at line 381 of file InPortCorbaCdrProvider.h.
Definition at line 383 of file InPortCorbaCdrProvider.h.