InPortPullConnector class. More...
Public Member Functions | |
def | __init__ |
Constructor. | |
def | __del__ |
Destructor. | |
def | read |
Destructor. | |
def | disconnect |
Disconnect connection. | |
def | activate |
Connector activation. | |
def | deactivate |
Connector deactivation. | |
def | createBuffer |
create buffer | |
def | onConnect |
Invoke callback when connection is establishedvoid onConnect(). | |
def | onDisconnect |
Invoke callback when connection is destroiedvoid onDisconnect(). |
InPortPullConnector class.
Connector class of InPort for pull type dataflow. When "pull" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the InPort. This connector and InPortPullConnector make a pair and realize pull type dataflow of data ports. One connector corresponds to one connection which provides a data stream. Connector is distinguished by ID of the UUID that is generated at establishing connection.
InPortPullConnector owns and manages the following objects.
Data written into the OutPort is passed to the OutPortPullConnector.write(), and is written into the buffer. Consequently, InPort.read() and InPortPullConnector.read() call OutPortConsumer.get(), and it reads data from the buffer of OutPortPullConnector. Finally data would be written into the InPortPullConnector's buffer.
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.__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.InPortPullConnector.InPortPullConnector.__init__ | ( | self, | ||
info, | ||||
consumer, | ||||
listeners, | ||||
buffer = 0 | ||||
) |
Constructor.
InPortPullConnector's constructor is given the following arguments. According to ConnectorInfo which includes connection information, a buffer is created. It is also given a pointer to the consumer object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortConsumer. OutPortPullConnector also has ConnectorListeners to provide event callback mechanisms, and they would be called at the proper timing. If data buffer is given by OutPortBase, the pointer to the buffer is also given as arguments.
info | ConnectorInfo | |
consumer | OutPortConsumer | |
listeners | ConnectorListeners type lsitener object list | |
buffer | CdrBufferBase type buffer |
InPortPullConnector(ConnectorInfo info, OutPortConsumer* consumer, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.activate | ( | self | ) |
Connector activation.
This operation activates this connector
virtual void activate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.createBuffer | ( | self, | ||
profile | ||||
) |
create buffer
This function creates a buffer based on given information.
info | Connector information |
CdrBufferBase* createBuffer(Profile& profile);
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.deactivate | ( | self | ) |
Connector deactivation.
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.disconnect | ( | self | ) |
Disconnect connection.
This operation disconnect this connection
virtual ReturnCode disconnect();
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
def OpenRTM_aist.InPortPullConnector.InPortPullConnector.read | ( | self, | ||
data | ||||
) |
Destructor.
This function get data from OutPortConsumer. 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.