クラス OpenRTM_aist.DataPortStatus.DataPortStatus

OpenRTM_aist.DataPortStatus.DataPortStatusに対する継承グラフ

Public メソッド
def	toString
	DataPortStatus リターンコードを文字列に変換.
Static Public 変数
int	PORT_OK = 0
	brief DataPortStatus リターンコード

説明

DataPortStatus mixin クラス.

このクラスは、enum定義されたリターンコードを、データポート関連のサブクラスで共通利用するための mixin クラスである。このリターンコードを使用するクラスでは、DataPortStatus クラスをpublic 継承し、下に define してあるDATAPORTSTATUS_ENUM をクラス内に記述することで利用可能となる。これにより、enum を ReturnCode_t 型として typedef し、以後ReturnCode_t を利用できるようにするとともに、名前空間に enum 定義された各識別子を当該クラス名前空間内に導入する。

メソッド

def OpenRTM_aist.DataPortStatus.DataPortStatus.toString ( status )

DataPortStatus リターンコードを文字列に変換.

DataPortStatus リターンコードを文字列に変換する

引数:

status

変換対象 DataPortStatus リターンコード

戻り値:: 文字列変換結果

変数

int OpenRTM_aist.DataPortStatus.DataPortStatus.PORT_OK = 0 [static]

brief DataPortStatus リターンコード

データポート関連のクラスで共通のリターンコード

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: 不明なエラー

データポートのデータ経路上のエラー発生個所から呼び出し側へエラー情報を伝えるためにこのエラーコードを使用する。主に、伝送路上のエラー、伝送先のエラーなどが考えられるが、各部分の界面で発生するエラーを以下に列挙する。

(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

各関数が返すリターンコードは関数ごとのリファレンスを参照のこと。

このクラスの説明は次のファイルから生成されました:

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/DataPortStatus.py

クラス OpenRTM_aist.DataPortStatus.DataPortStatus

Public メソッド

Static Public 変数

説明

メソッド

変数