OpenRTM-aist-Python 2.0.2
|
Public Member Functions | |
__init__ (self) | |
__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer) | |
init (self, prop) | |
setBuffer (self, buffer) | |
get (self) | |
subscribeInterface (self, properties) | |
unsubscribeInterface (self, properties) | |
convertReturn (self, status, data) | |
onBufferWrite (self, data) | |
Connector data listener functions. | |
onSenderEmpty (self) | |
Connector listener functions. | |
![]() | |
toString (status) | |
![]() | |
equal (self, consumer) | |
setObject (self, obj) | |
releaseObject (self) | |
![]() | |
getObject (self) | |
Additional Inherited Members | |
![]() | |
int | PORT_OK = 0 |
![]() | |
_ptr (self, get_ref=False) | |
OutPortDSConsumer class
This is an implementation class of the output Consumer that uses CORBA for means of communication.
DataType | Data type for this port |
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.__init__ | ( | self | ) |
Constructor
Constructor
buffer | Buffer that is attached to this port |
Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.__del__ | ( | self, | |
CorbaConsumer = OpenRTM_aist.CorbaConsumer ) |
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.convertReturn | ( | self, | |
status, | |||
data ) |
Return codes conversion
ReturnCode convertReturn(.OpenRTM.PortStatus status, const cdrMemoryStream& data)
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.get | ( | self | ) |
Read data
Read set data
data | Object to receive the read data |
virtual ReturnCode get(cdrMemoryStream& data);
Reimplemented from OpenRTM_aist.OutPortConsumer.OutPortConsumer.
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.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.
prop | Configuration information |
virtual void init(coil.Properties& prop);
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.onBufferWrite | ( | self, | |
data ) |
Connector data listener functions.
inline void onBufferWrite(const cdrMemoryStream& data)
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.onSenderEmpty | ( | self | ) |
Connector listener functions.
inline void onSenderEmpty()
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.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.
buffer | A pointer to a data buffer to be used by OutPortProvider |
virtual void setBuffer(CdrBufferBase* buffer);
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.subscribeInterface | ( | self, | |
properties ) |
Subscribe the data receive notification
Subscribe the data receive notification based on specified property information
properties | Subscription information |
virtual bool subscribeInterface(const SDOPackage.NVList& properties);
OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.unsubscribeInterface | ( | self, | |
properties ) |
Unsubscribe the data receive notification
Unsubscribe the data receive notification.
properties | Unsubscription information |
virtual void unsubscribeInterface(const SDOPackage.NVList& properties);