DataPortStatus mixin class. More...
Public Member Functions | |
| def | __init__ (self) |
| def | toString (status) |
| Convert DataPortStatus into the string. More... | |
Static Public Attributes | |
| 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
DataPortStatus mixin class.
This is a mixin class to provide enumed return codes that are commonly utilised in data port related sub-classes. To use this class, sub-class should inherit this class as a public super class, and declare DATAPORTSTATUS_ENUM defined below. Consequently, ReturnCode_t type that is typedefed by this macro can be used in the sub-class, and enumed identifiers are imported to the class's namespace.
Definition at line 47 of file DataPortStatus.py.
Constructor & Destructor Documentation
| def OpenRTM_aist.DataPortStatus.DataPortStatus.__init__ | ( | self | ) |
Definition at line 51 of file DataPortStatus.py.
Member Function Documentation
| def OpenRTM_aist.DataPortStatus.DataPortStatus.toString | ( | status | ) |
Convert DataPortStatus into the string.
Convert DataPortStatus into the string.
- Parameters
-
status The target DataPortStatus for transformation
- Returns
- Trnasformation result of string representation
Definition at line 178 of file DataPortStatus.py.
Member Data Documentation
|
static |
Definition at line 144 of file DataPortStatus.py.
|
static |
Definition at line 142 of file DataPortStatus.py.
|
static |
Definition at line 143 of file DataPortStatus.py.
|
static |
Definition at line 145 of file DataPortStatus.py.
|
static |
Definition at line 152 of file DataPortStatus.py.
|
static |
Definition at line 150 of file DataPortStatus.py.
|
static |
Definition at line 141 of file DataPortStatus.py.
|
static |
DataPortStatus return codes.
Common return codes for data ports related classes.
- PORT_OK: Normal return
- PORT_ERROR: Error return
- BUFFER_ERROR: Buffer error
- BUFFER_FULL: Buffer full
- BUFFER_EMPTY: Buffer empty
- BUFFER_TIMEOUT: Buffer timeout
- SEND_FULL: Buffer full although OutPort tried to send data
- SEND_TIMEOUT: Timeout although OutPort tried to send data
- RECV_EMPTY: Buffer empty although InPort tried to receive data
- RECV_TIMEOUT: Timeout although InPort tried to receive data
- INVALID_ARGS: Invalid arguments
- PRECONDITION_NOT_MET: Precondition not met
- CONNECTION_LOST: Connection has been lost
- UNKNOWN_ERROR: Unknown error
This error codes might be used to propagate error status from the error occurring point to the function caller in the data stream path. It would occur in data-transfer path and data receiver/sender. The errors that occur in the interface of each portion of data port are shown below.
(1) Push Type a) The return codes between InPortConsumer and Publisher/Activity PORT_OK, PORT_ERROR, SEND_FULL, SEND_TIMEOUT, CONNECTION_LOST, UNKNOWN_ERROR b) The return codes between Activity and Buffer/Connector of OutPort PORT_OK, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_TIMEOUT, UNKNOWN_ERROR,
(2) Pull Type a) The return codes between Activity and InPort PORT_OK, PORT_ERROR, RECV_EMPTY, RECV_TIMEOUT, CONNETION_LOST, UNKNOWN_ERROR
See function references for detailed return codes for each function.
Definition at line 140 of file DataPortStatus.py.
|
static |
Definition at line 151 of file DataPortStatus.py.
|
static |
Definition at line 148 of file DataPortStatus.py.
|
static |
Definition at line 149 of file DataPortStatus.py.
|
static |
Definition at line 146 of file DataPortStatus.py.
|
static |
Definition at line 147 of file DataPortStatus.py.
|
static |
Definition at line 195 of file DataPortStatus.py.
|
static |
Definition at line 153 of file DataPortStatus.py.
The documentation for this class was generated from the following file: