InPortPushConnector class. More...
Public Member Functions | |
def | __del__ |
Destructor. | |
def | __init__ |
InPortPushConnector(ConnectorInfo info, InPortProvider* provider, ConnectorListeners listeners, CdrBufferBase* buffer = 0);. | |
def | activate |
Connector activation. | |
def | createBuffer |
create buffer | |
def | deactivate |
Connector deactivation. | |
def | disconnect |
disconnect | |
def | onConnect |
Invoke callback when connection is established void onConnect() | |
def | onDisconnect |
Invoke callback when connection is destroied void onDisconnect() | |
def | read |
Reading data. | |
def | write |
Reading data. | |
Private Attributes | |
_buffer | |
_deleteBuffer | |
_listeners | |
_provider |
InPortPushConnector class.
Connector class of InPort for push type dataflow. When "push" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the InPort. This connector and OutPortPushConnector make a pair and realize push 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.
InPortPushConnector owns and manages the following objects.
Data written into the OutPort are passed to the InPortProvider::put() by OutPortConnector. The data is written into the buffer in the connector.
Definition at line 76 of file InPortPushConnector.py.
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.__init__ | ( | self, | |
info, | |||
provider, | |||
listeners, | |||
buffer = 0 |
|||
) |
InPortPushConnector(ConnectorInfo info, InPortProvider* provider, ConnectorListeners listeners, CdrBufferBase* buffer = 0);.
Definition at line 122 of file InPortPushConnector.py.
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
Definition at line 162 of file InPortPushConnector.py.
Connector activation.
This operation activates this connector
virtual void activate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
Definition at line 288 of file InPortPushConnector.py.
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.createBuffer | ( | self, | |
profile | |||
) |
create buffer
This function creates a buffer based on given information.
info | Connector information |
virtual CdrBufferBase* createBuffer(Profile& profile);
Definition at line 330 of file InPortPushConnector.py.
Connector deactivation.
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.
Definition at line 306 of file InPortPushConnector.py.
disconnect
This operation destruct and delete the consumer, the publisher and the buffer.
virtual ReturnCode disconnect();
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
Definition at line 254 of file InPortPushConnector.py.
Invoke callback when connection is established void onConnect()
Definition at line 390 of file InPortPushConnector.py.
Invoke callback when connection is destroied void onDisconnect()
Definition at line 402 of file InPortPushConnector.py.
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.read | ( | self, | |
data | |||
) |
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); buffer returns BUFFER_OK BUFFER_EMPTY TIMEOUT PRECONDITION_NOT_MET
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
Definition at line 199 of file InPortPushConnector.py.
def OpenRTM_aist.InPortPushConnector.InPortPushConnector.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);
Definition at line 367 of file InPortPushConnector.py.
Reimplemented from OpenRTM_aist.InPortConnector.InPortConnector.
Definition at line 122 of file InPortPushConnector.py.
Definition at line 122 of file InPortPushConnector.py.
Definition at line 122 of file InPortPushConnector.py.
Definition at line 122 of file InPortPushConnector.py.