InPortPullConnector class. More...
Public Member Functions | |
| def | __del__ (self) |
| Destructor. More... | |
| def | __init__ (self, info, consumer, listeners, buffer=0) |
| Constructor. More... | |
| def | activate (self) |
| Connector activation. More... | |
| def | createBuffer (self, profile) |
| create buffer More... | |
| def | deactivate (self) |
| Connector deactivation. More... | |
| def | disconnect (self) |
| Disconnect connection. More... | |
| def | onConnect (self) |
| Invoke callback when connection is established void onConnect() More... | |
| def | onDisconnect (self) |
| Invoke callback when connection is destroied void onDisconnect() More... | |
| def | read (self, data) |
| Destructor. More... | |
 Public Member Functions inherited from OpenRTM_aist.InPortConnector.InPortConnector | |
| def | __del__ (self) |
| Destructor. More... | |
| def | __init__ (self, info, buffer) |
| ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);. More... | |
| def | disconnect (self) |
| Disconnect connection. More... | |
| def | getBuffer (self) |
| Getting Buffer. More... | |
| def | id (self) |
| Getting Connector ID. More... | |
| def | name (self) |
| Getting Connector name. More... | |
| def | profile (self) |
| Getting ConnectorInfo. More... | |
| def | read (self, data) |
| Destructor. More... | |
| def | setConnectorInfo (self, profile) |
| def | setDataType (self, data) |
| Public Member Functions inherited from OpenRTM_aist.ConnectorBase.ConnectorBase | |
| def | __del__ (self) |
| Destructor. More... | |
| def | activate (self) |
| Connector activation. More... | |
| def | deactivate (self) |
| Connector deactivation. More... | |
| def | disconnect (self) |
| Disconnect connection. More... | |
| def | getBuffer (self) |
| Getting Buffer. More... | |
| def | id (self) |
| Getting Connector ID. More... | |
| def | name (self) |
| Getting Connector name. More... | |
| def | profile (self) |
| Getting Profile. More... | |
| Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| def | __init__ (self) |
| def | toString (status) |
| Convert DataPortStatus into the string. More... | |
Private Attributes | |
| _buffer | |
| _consumer | |
| _listeners | |
Additional Inherited Members | |
| Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| int | BUFFER_EMPTY = 4 |
| int | BUFFER_ERROR = 2 |
| int | BUFFER_FULL = 3 |
| int | BUFFER_TIMEOUT = 5 |
| int | CONNECTION_LOST = 12 |
| int | INVALID_ARGS = 10 |
| int | PORT_ERROR = 1 |
| int | PORT_OK = 0 |
| DataPortStatus return codes. More... | |
| int | PRECONDITION_NOT_MET = 11 |
| int | RECV_EMPTY = 8 |
| int | RECV_TIMEOUT = 9 |
| int | SEND_FULL = 6 |
| int | SEND_TIMEOUT = 7 |
| toString = staticmethod(toString) | |
| int | UNKNOWN_ERROR = 13 |
Detailed Description
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.
- InPortConsumer
- Buffer
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.
- Since
- 1.0.0
Definition at line 79 of file InPortPullConnector.py.
Constructor & Destructor Documentation
| 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.
- Parameters
-
info ConnectorInfo consumer OutPortConsumer listeners ConnectorListeners type lsitener object list buffer CdrBufferBase type buffer
InPortPullConnector(ConnectorInfo info, OutPortConsumer* consumer, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);
Definition at line 127 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.__del__ | ( | self | ) |
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Definition at line 159 of file InPortPullConnector.py.
Member Function Documentation
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.activate | ( | self | ) |
Connector activation.
This operation activates this connector
virtual void activate(){}; // do nothing
Definition at line 254 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.createBuffer | ( | self, | |
| profile | |||
| ) |
create buffer
This function creates a buffer based on given information.
- Parameters
-
info Connector information
- Returns
- The poitner to the buffer
CdrBufferBase* createBuffer(Profile& profile);
Definition at line 295 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.deactivate | ( | self | ) |
Connector deactivation.
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
Definition at line 272 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.disconnect | ( | self | ) |
Disconnect connection.
This operation disconnect this connection
virtual ReturnCode disconnect();
Definition at line 229 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.onConnect | ( | self | ) |
Invoke callback when connection is established void onConnect()
Definition at line 306 of file InPortPullConnector.py.
| def OpenRTM_aist.InPortPullConnector.InPortPullConnector.onDisconnect | ( | self | ) |
Invoke callback when connection is destroied void onDisconnect()
Definition at line 318 of file InPortPullConnector.py.
| 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.
- 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);
Definition at line 195 of file InPortPullConnector.py.
Member Data Documentation
|
private |
Definition at line 132 of file InPortPullConnector.py.
|
private |
Definition at line 129 of file InPortPullConnector.py.
|
private |
Definition at line 130 of file InPortPullConnector.py.
The documentation for this class was generated from the following file: