Public Member Functions | |
| def | __init__ (self) |
| def | __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer) |
| def | init (self, prop) |
| def | setBuffer (self, buffer) |
| def | get (self) |
| def | subscribeInterface (self, properties) |
| def | unsubscribeInterface (self, properties) |
| def | convertReturn (self, status, data) |
| def | onBufferWrite (self, data) |
| Connector data listener functions. More... | |
| def | onSenderEmpty (self) |
| Connector listener functions. More... | |
 Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| def | toString (status) |
| Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer | |
| def | __init__ (self, interfaceType=None, consumer=None) |
| def | equal (self, consumer) |
| def | setObject (self, obj) |
| def | releaseObject (self) |
| Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase | |
| def | __init__ (self, consumer=None) |
| def | equal (self, consumer) |
| def | setObject (self, obj) |
| def | getObject (self) |
| def | releaseObject (self) |
Additional Inherited Members | |
| Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| int | PORT_OK = 0 |
Detailed Description
OutPortCorbaCdrConsumer class
This is an implementation class of the output Consumer that uses CORBA for means of communication.
- Parameters
-
DataType Data type for this port
- Since
- 1.0.0
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__ | ( | self | ) |
Constructor
Constructor
- Parameters
-
buffer Buffer that is attached to this port
Reimplemented from OpenRTM_aist.CorbaConsumer.CorbaConsumer.
Reimplemented in OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, and OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumer.
◆ __del__()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__del__ | ( | self, | |
CorbaConsumer = OpenRTM_aist.CorbaConsumer |
|||
| ) |
Destructor
Destructor
Reimplemented from OpenRTM_aist.CorbaConsumer.CorbaConsumer.
Reimplemented in OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, and OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumer.
Member Function Documentation
◆ convertReturn()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.convertReturn | ( | self, | |
| status, | |||
| data | |||
| ) |
Return codes conversion
ReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data)
◆ get()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.get | ( | self | ) |
Read data
Read set data
- Parameters
-
data Object to receive the read data
- Returns
- Read result (Successful:true, Failed:false)
virtual ReturnCode get(cdrMemoryStream& data);
Reimplemented from OpenRTM_aist.OutPortConsumer.OutPortConsumer.
Reimplemented in OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, and OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumer.
◆ init()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.init | ( | self, | |
| prop | |||
| ) |
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.
- Parameters
-
prop Configuration information
virtual void init(coil::Properties& prop);
Reimplemented in OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer, and OpenRTM_aist.OutPortSHMConsumer.OutPortSHMConsumer.
◆ onBufferWrite()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onBufferWrite | ( | self, | |
| data | |||
| ) |
Connector data listener functions.
inline void onBufferWrite(const cdrMemoryStream& data)
◆ onSenderEmpty()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderEmpty | ( | self | ) |
Connector listener functions.
inline void onSenderEmpty()
◆ setBuffer()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.setBuffer | ( | self, | |
| buffer | |||
| ) |
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.
- Parameters
-
buffer A pointer to a data buffer to be used by OutPortProvider
virtual void setBuffer(CdrBufferBase* buffer);
Reimplemented in OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.
◆ subscribeInterface()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.subscribeInterface | ( | self, | |
| properties | |||
| ) |
Subscribe the data receive notification
Subscribe the data receive notification based on specified property information
- Parameters
-
properties Subscription information
- Returns
- Subscription result (Successful:true, Failed:false)
virtual bool subscribeInterface(const SDOPackage::NVList& properties);
◆ unsubscribeInterface()
| def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.unsubscribeInterface | ( | self, | |
| properties | |||
| ) |
Unsubscribe the data receive notification
Unsubscribe the data receive notification.
- Parameters
-
properties Unsubscription information
virtual void unsubscribeInterface(const SDOPackage::NVList& properties);
The documentation for this class was generated from the following file:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/OutPortCorbaCdrConsumer.py
