InPortPushConnector class. More...
Public Member Functions | |
| def | __init__ (self, info, provider, listeners, buffer=0) |
| InPortPushConnector(ConnectorInfo info, InPortProvider* provider, ConnectorListeners listeners, CdrBufferBase* buffer = 0);. | |
| def | __del__ (self) |
| Destructor. More... | |
| def | read (self, data) |
| Reading data. More... | |
| def | disconnect (self) |
| disconnect More... | |
| def | activate (self) |
| Connector activation. More... | |
| def | deactivate (self) |
| Connector deactivation. More... | |
| def | createBuffer (self, profile) |
| create buffer More... | |
| def | write (self, data) |
| Reading data. More... | |
| def | onConnect (self) |
| Invoke callback when connection is established void onConnect() | |
| def | onDisconnect (self) |
| Invoke callback when connection is destroied void onDisconnect() | |
 Public Member Functions inherited from OpenRTM_aist.InPortConnector.InPortConnector | |
| def | __init__ (self, info, buffer) |
| ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);. | |
| def | __del__ (self) |
| Destructor. | |
| def | profile (self) |
| Getting ConnectorInfo. More... | |
| def | id (self) |
| Getting Connector ID. More... | |
| def | name (self) |
| Getting Connector name. More... | |
| def | disconnect (self) |
| Disconnect connection. More... | |
| def | getBuffer (self) |
| Getting Buffer. More... | |
| def | read (self, data) |
| Destructor. More... | |
| Public Member Functions inherited from OpenRTM_aist.ConnectorBase.ConnectorBase | |
| def | __del__ (self) |
| Destructor. | |
| def | profile (self) |
| Getting Profile. More... | |
| def | id (self) |
| Getting Connector ID. More... | |
| def | name (self) |
| Getting Connector name. More... | |
| def | disconnect (self) |
| Disconnect connection. More... | |
| def | getBuffer (self) |
| Getting Buffer. More... | |
| def | activate (self) |
| Connector activation. More... | |
| def | deactivate (self) |
| Connector deactivation. More... | |
| Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| def | toString (status) |
| Convert DataPortStatus into the string. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| int | PORT_OK = 0 |
| DataPortStatus return codes. More... | |
Detailed Description
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.
- OutPortConsumer
- Buffer
Data written into the OutPort are passed to the InPortProvider::put() by OutPortConnector. The data is written into the buffer in the connector.
- Since
- 1.0.0
Constructor & Destructor Documentation
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.__del__ | ( | self | ) |
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Member Function Documentation
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.activate | ( | self | ) |
Connector activation.
This operation activates this connector
virtual void activate(){}; // do nothing
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.createBuffer | ( | self, | |
| profile | |||
| ) |
create buffer
This function creates a buffer based on given information.
- Parameters
-
info Connector information
- Returns
- The poitner to the buffer
virtual CdrBufferBase* createBuffer(Profile& profile);
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.deactivate | ( | self | ) |
Connector deactivation.
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
| def OpenRTM_aist.InPortPushConnector.InPortPushConnector.disconnect | ( | self | ) |
disconnect
This operation destruct and delete the consumer, the publisher and the buffer.
- Returns
- PORT_OK
virtual ReturnCode disconnect();
| 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.
- Returns
- PORT_OK Normal return BUFFER_EMPTY Buffer empty TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met PORT_ERROR Other error
virtual ReturnCode read(cdrMemoryStream& data); buffer returns BUFFER_OK BUFFER_EMPTY TIMEOUT PRECONDITION_NOT_MET
| 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.
- Returns
- BUFFER_OK Normal return BUFFER_FULL Buffer full TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met BUFFER_ERROR Other error
ReturnCode write(const OpenRTM::CdrData& data);
The documentation for this class was generated from the following file:
- /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/InPortPushConnector.py
