I£îPortConnector base class. More...
Public Member Functions | |
| 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 | |
| _dataType | |
| _endian | |
| _profile | |
| _rtcout | |
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
I£îPortConnector base class.
The base class to derive subclasses for InPort's Push/Pull Connectors
- Since
- 1.0.0
Definition at line 43 of file InPortConnector.py.
Constructor & Destructor Documentation
| def OpenRTM_aist.InPortConnector.InPortConnector.__init__ | ( | self, | |
| info, | |||
| buffer | |||
| ) |
ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);.
Definition at line 56 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.__del__ | ( | self | ) |
Destructor.
Definition at line 71 of file InPortConnector.py.
Member Function Documentation
| def OpenRTM_aist.InPortConnector.InPortConnector.disconnect | ( | self | ) |
Disconnect connection.
This operation disconnect this connection
virtual ReturnCode disconnect() = 0;
Definition at line 146 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.getBuffer | ( | self | ) |
Getting Buffer.
This operation returns this connector's buffer
virtual CdrBufferBase* getBuffer();
Definition at line 163 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.id | ( | self | ) |
Getting Connector ID.
This operation returns Connector ID
const char* id();
Definition at line 108 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.name | ( | self | ) |
Getting Connector name.
This operation returns Connector name
const char* name();
Definition at line 127 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.profile | ( | self | ) |
Getting ConnectorInfo.
This operation returns ConnectorInfo
const ConnectorInfo& profile();
Definition at line 89 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.read | ( | self, | |
| data | |||
| ) |
Destructor.
The read function to read data from buffer to InPort
virtual ReturnCode read(cdrMemoryStream& data) = 0;
Definition at line 180 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.setConnectorInfo | ( | self, | |
| profile | |||
| ) |
Definition at line 184 of file InPortConnector.py.
| def OpenRTM_aist.InPortConnector.InPortConnector.setDataType | ( | self, | |
| data | |||
| ) |
Definition at line 212 of file InPortConnector.py.
Member Data Documentation
|
private |
Definition at line 59 of file InPortConnector.py.
|
private |
Definition at line 60 of file InPortConnector.py.
|
private |
Definition at line 61 of file InPortConnector.py.
|
private |
Definition at line 58 of file InPortConnector.py.
|
private |
Definition at line 57 of file InPortConnector.py.
The documentation for this class was generated from the following file: