OpenRTM-aist
1.2.1
|
OutPortCorbaCdrConsumer class. More...
#include <OutPortCorbaCdrConsumer.h>
Public Member Functions | |
DATAPORTSTATUS_ENUM | OutPortCorbaCdrConsumer () |
Constructor. More... | |
virtual | ~OutPortCorbaCdrConsumer (void) |
Destructor. More... | |
virtual void | init (coil::Properties &prop) |
Initializing configuration. More... | |
virtual void | setBuffer (CdrBufferBase *buffer) |
Setting outside buffer's pointer. More... | |
virtual void | setListener (ConnectorInfo &info, ConnectorListeners *listeners) |
Set the listener. More... | |
virtual ReturnCode | get (cdrMemoryStream &data) |
Read data. More... | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties) |
Subscribe the data receive notification. More... | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties) |
Unsubscribe the data receive notification. More... | |
Public Member Functions inherited from RTC::OutPortConsumer | |
virtual DATAPORTSTATUS_ENUM | ~OutPortConsumer (void) |
Destructor. More... | |
Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::OutPortCdr > | |
CorbaConsumer () | |
Consructor. More... | |
CorbaConsumer (const CorbaConsumer &x) | |
Copy constructor. More... | |
CorbaConsumer & | operator= (const CorbaConsumer &x) |
Assignment operator. More... | |
void | swap (CorbaConsumer &x) |
virtual | ~CorbaConsumer (void) |
Virtual destructor. More... | |
virtual bool | setObject (CORBA::Object_ptr obj) |
Set Object. More... | |
typename::OpenRTM::OutPortCdr::_ptr_type | _ptr () |
Get Object reference narrowed as ObjectType. More... | |
typename::OpenRTM::OutPortCdr::_ptr_type | operator-> () |
Get Object reference narrowed as ObjectType. More... | |
virtual void | releaseObject () |
Clear CORBA object setting. More... | |
Public Member Functions inherited from RTC::CorbaConsumerBase | |
CorbaConsumerBase () | |
Consructor. More... | |
CorbaConsumerBase (const CorbaConsumerBase &x) | |
Copy Consructor. More... | |
CorbaConsumerBase & | operator= (const CorbaConsumerBase &x) |
Assignment operator. More... | |
void | swap (CorbaConsumerBase &x) |
swap function More... | |
virtual | ~CorbaConsumerBase (void) |
Virtual destructor. More... | |
virtual CORBA::Object_ptr | getObject () |
Get CORBA Object. More... | |
Additional Inherited Members | |
Public Types inherited from RTC::DataPortStatus | |
enum | Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR } |
DataPortStatus return codes. More... | |
Static Public Member Functions inherited from RTC::DataPortStatus | |
static const char * | toString (DataPortStatus::Enum status) |
Convert DataPortStatus into the string. More... | |
Protected Attributes inherited from RTC::OutPortConsumer | |
Logger | rtclog |
Logger stream. More... | |
Protected Attributes inherited from RTC::CorbaConsumer< ::OpenRTM::OutPortCdr > | |
typename::OpenRTM::OutPortCdr::_var_type | m_var |
CORBA object which has been set. More... | |
Protected Attributes inherited from RTC::CorbaConsumerBase | |
CORBA::Object_var | m_objref |
CORBA object which is set. More... | |
OutPortCorbaCdrConsumer class.
The OutPort consumer class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a pull-type dataflow.
DATAPORTSTATUS_ENUM RTC::OutPortCorbaCdrConsumer::OutPortCorbaCdrConsumer | ( | ) |
Constructor.
Constructor
|
virtual |
Destructor.
Destructor
|
virtual |
Read data.
Read set data
data | Object to receive the read data |
Implements RTC::OutPortConsumer.
|
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.
|
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.
|
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.
|
virtual |
Subscribe the data receive notification.
Subscribe the data receive notification based on specified property information
properties | Subscription information |
Implements RTC::OutPortConsumer.
|
virtual |
Unsubscribe the data receive notification.
Unsubscribe the data receive notification.
properties | Unsubscription information |
Implements RTC::OutPortConsumer.