OutPortPullConnector class. More...
Public Member Functions | |
| def | __del__ (self) |
| Destructor. More... | |
| def | __init__ (self, info, provider, listeners, buffer=0) |
| Constructor. More... | |
| def | activate (self) |
| Connector activation. More... | |
| def | createBuffer (self, info) |
| create bufferCdrBufferBase* createBuffer(ConnectorInfo& info); More... | |
| def | deactivate (self) |
| Connector deactivation. More... | |
| def | disconnect (self) |
| disconnect More... | |
| def | getBuffer (self) |
| Getting Buffer. 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 | write (self, data) |
| Writing data. More... | |
 Public Member Functions inherited from OpenRTM_aist.OutPortConnector.OutPortConnector | |
| def | __del__ (self) |
| Destructor. More... | |
| def | __init__ (self, info) |
| ConstructorOutPortConnector(ConnectorInfo& info);. More... | |
| def | id (self) |
| Getting Connector ID. More... | |
| def | name (self) |
| Getting Connector name. More... | |
| def | profile (self) |
| Getting ConnectorInfo. More... | |
| def | setConnectorInfo (self, info) |
| 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 | |
| _listeners | |
| _provider | |
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
OutPortPullConnector class.
Connector class of OutPort 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 OutPort. 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.
OutPortPullConnector owns and manages the following objects.
- InPortConsumer
- Buffer
Data written into the OutPort is passed to OutPortPullConnector::write(), and it is written into the buffer. By reading data from OutPortPullConnector to InPortPullConnector, data transfer is realized.
- Since
- 1.0.0
Definition at line 77 of file OutPortPullConnector.py.
Constructor & Destructor Documentation
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__init__ | ( | self, | |
| info, | |||
| provider, | |||
| listeners, | |||
buffer = 0 |
|||
| ) |
Constructor.
OutPortPullConnector'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 provider object for the OutPort interface. The owner-ship of the pointer is owned by this OutPortPullConnector, it has responsibility to destruct the OutPortProvider. 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 provider OutPortProvider listeners ConnectorListeners type lsitener object list buffer CdrBufferBase type buffer
OutPortPullConnector(ConnectorInfo info, OutPortProvider* provider, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);
Definition at line 125 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.__del__ | ( | self | ) |
Destructor.
This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.
Definition at line 161 of file OutPortPullConnector.py.
Member Function Documentation
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.activate | ( | self | ) |
Connector activation.
This operation activates this connector
virtual void activate(){}; // do nothing
Definition at line 260 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.createBuffer | ( | self, | |
| info | |||
| ) |
create bufferCdrBufferBase* createBuffer(ConnectorInfo& info);
Definition at line 291 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.deactivate | ( | self | ) |
Connector deactivation.
This operation deactivates this connector
virtual void deactivate(){}; // do nothing
Definition at line 279 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.disconnect | ( | self | ) |
disconnect
This operation destruct and delete the consumer, the publisher and the buffer.
virtual ReturnCode disconnect();
Definition at line 211 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.getBuffer | ( | self | ) |
Getting Buffer.
This operation returns this connector's buffer
virtual CdrBufferBase* getBuffer();
Definition at line 241 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onConnect | ( | self | ) |
Invoke callback when connection is established void onConnect()
Definition at line 303 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.onDisconnect | ( | self | ) |
Invoke callback when connection is destroied void onDisconnect()
Definition at line 316 of file OutPortPullConnector.py.
| def OpenRTM_aist.OutPortPullConnector.OutPortPullConnector.write | ( | self, | |
| data | |||
| ) |
Writing data.
This operation writes data into publisher and then the data will be transferred to correspondent InPort.
virtual ReturnCode write(const cdrMemoryStream& data);
Definition at line 182 of file OutPortPullConnector.py.
Member Data Documentation
|
private |
Definition at line 129 of file OutPortPullConnector.py.
|
private |
Definition at line 128 of file OutPortPullConnector.py.
|
private |
Definition at line 127 of file OutPortPullConnector.py.
The documentation for this class was generated from the following file: