RTC::BufferStatus Class Reference
BufferStatus mixin class. More...
#include <BufferStatus.h>
Inheritance diagram for RTC::BufferStatus:
Public Types | |
| enum | Enum { BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET } |
DataPortStatus return codes. More... | |
Static Public Member Functions | |
| static const char * | toString (Enum status) |
| Convert BufferStatus into the string. | |
Detailed Description
BufferStatus mixin class.
This is a mixin class to provide enumed return codes that are commonly utilised in buffer realted sub-classes. To use this class, sub-class should inherit this class as a public super class, and declare BUFFERSTATUS_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.
Member Enumeration Documentation
DataPortStatus return codes.
Common return codes for buffer classes.
- BUFFER_OK: Normal return
- BUFFER_ERROR: Buffer error
- BUFFER_FULL: Buffer full
- BUFFER_EMPTY: Buffer empty
- NOT_SUPPORTED: Not supported function
- TIMEOUT: Timeout
- PRECONDITION_NOT_MET: Precodition not met
Member Function Documentation
| static const char* RTC::BufferStatus::toString | ( | Enum | status | ) | [inline, static] |
Convert BufferStatus into the string.
Convert BufferStatus into the string.
- Parameters:
-
status The target BufferStatus for transformation
- Returns:
- Trnasformation result of string representation
