OpenRTM-aist-Python 2.0.0
|
Public Member Functions | |
def | __init__ (self, info, provider, listeners, buffer=None) |
def | __del__ (self) |
def | readBuff (self) |
def | read (self, data=None) |
def | disconnect (self) |
def | activate (self) |
def | deactivate (self) |
def | createBuffer (self, profile) |
def | write (self, data) |
def | onConnect (self) |
def | onDisconnect (self) |
def | setConsumer (self, consumer) |
def | deserializeData (self, cdr) |
def | unsubscribeInterface (self, prop) |
Public Member Functions inherited from OpenRTM_aist.InPortConnector.InPortConnector | |
def | __init__ (self, info, buffer) |
def | __del__ (self) |
def | profile (self) |
def | id (self) |
def | name (self) |
def | disconnect (self) |
def | getBuffer (self) |
def | read (self, data=None) |
def | setConsumer (self, consumer) |
def | unsubscribeInterface (self, prop) |
def | __del__ (self) |
def | profile (self) |
def | id (self) |
def | name (self) |
def | disconnect (self) |
def | getBuffer (self) |
def | activate (self) |
def | deactivate (self) |
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
def | toString (status) |
Additional Inherited Members | |
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
int | PORT_OK = 0 |
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.__del__ | ( | self | ) |
Destructor
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.activate | ( | self | ) |
Connector activation
This operation activates this connector
virtual void activate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.createBuffer | ( | self, | |
profile | |||
) |
create buffer
This function creates a buffer based on given information.
info | Connector information |
virtual CdrBufferBase* createBuffer(Profile& profile);
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deactivate | ( | self | ) |
Connector deactivation
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.deserializeData | ( | self, | |
cdr | |||
) |
self | |
cdr |
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.disconnect | ( | self | ) |
disconnect
This operation destruct and delete the consumer, the publisher and the buffer.
virtual ReturnCode disconnect();
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onConnect | ( | self | ) |
Invoke callback when connection is established void onConnect()
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.onDisconnect | ( | self | ) |
Invoke callback when connection is destroied void onDisconnect()
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.read | ( | self, | |
data = None |
|||
) |
Reading data
This function reads data from the buffer. If data is read properly, this function will return PORT_OK return code. Except normal return, BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET and PORT_ERROR will be returned as error codes.
virtual ReturnCode read(cdrMemoryStream& data);
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.setConsumer | ( | self, | |
consumer | |||
) |
set Consumer
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.unsubscribeInterface | ( | self, | |
prop | |||
) |
prop |
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortDuplexConnector.InPortDuplexConnector.write | ( | self, | |
data | |||
) |
Reading data
This function write data to the buffer. If data is write properly, this function will return BUFFER_OK return code. Except normal return, BUFFER_FULL, TIMEOUT, PRECONDITION_NOT_MET and BUFFER_ERROR will be returned as error codes.
ReturnCode write(const OpenRTM::CdrData& data);
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.