OpenRTM-aist
1.2.1
|
DataPortStatus mixin クラス [詳解]
#include <DataPortStatus.h>
公開型 | |
enum | Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR } |
静的公開メンバ関数 | |
static const char * | toString (DataPortStatus::Enum status) |
DataPortStatus リターンコードを文字列に変換 [詳解] | |
DataPortStatus mixin クラス
このクラスは、enum定義されたリターンコードを、データポート関連のサ ブクラスで共通利用するための mixin クラスである。このリターンコー ドを使用するクラスでは、DataPortStatus クラスをpublic 継承し、下に define してあるDATAPORTSTATUS_ENUM をクラス内に記述することで利用 可能となる。これにより、enum を ReturnCode_t 型として typedef し、 以後ReturnCode_t を利用できるようにするとともに、名前空間に enum 定義された各識別子を当該クラス名前空間内に導入する。
brief DataPortStatus リターンコード
データポート関連のクラスで共通のリターンコード
データポートのデータ経路上のエラー発生個所から呼び出し側へエラー 情報を伝えるためにこのエラーコードを使用する。主に、伝送路上のエ ラー、伝送先のエラーなどが考えられるが、各部分の界面で発生するエ ラーを以下に列挙する。
(1) Push型 a) InPortConsumer と Publisher/Activity 間で発生するリターンコード PORT_OK, PORT_ERROR, SEND_FULL, SEND_TIMEOUT, CONNECTION_LOST, UNKNOWN_ERROR
b) Activity と OutPort の Buffer/Connector 間で発生するリターンコード PORT_OK, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_TIMEOUT, UNKNOWN_ERROR,
(2) Pull型 a) Activity と InPort の間で発生するリターンコード PORT_OK, PORT_ERROR, RECV_EMPTY, RECV_TIMEOUT, CONNETION_LOST, UNKNOWN_ERROR
各関数が返すリターンコードは関数ごとのリファレンスを参照のこと。
列挙値 | |
---|---|
PORT_OK | |
PORT_ERROR | |
BUFFER_ERROR | |
BUFFER_FULL | |
BUFFER_EMPTY | |
BUFFER_TIMEOUT | |
SEND_FULL | |
SEND_TIMEOUT | |
RECV_EMPTY | |
RECV_TIMEOUT | |
INVALID_ARGS | |
PRECONDITION_NOT_MET | |
CONNECTION_LOST | |
UNKNOWN_ERROR |
|
inlinestatic |
DataPortStatus リターンコードを文字列に変換
DataPortStatus リターンコードを文字列に変換する
status | 変換対象 DataPortStatus リターンコード |