jp.go.aist.rtm.RTC.port
列挙型 ReturnCode
java.lang.Object
java.lang.Enum<ReturnCode>
jp.go.aist.rtm.RTC.port.ReturnCode
- すべての実装されたインタフェース:
- java.io.Serializable, java.lang.Comparable<ReturnCode>
public enum ReturnCode
- extends java.lang.Enum<ReturnCode>
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
各関数が返すリターンコードは関数ごとのリファレンスを参照のこと。
クラス java.lang.Enum から継承されたメソッド |
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
クラス java.lang.Object から継承されたメソッド |
getClass, notify, notifyAll, wait, wait, wait |
PORT_OK
public static final ReturnCode PORT_OK
PORT_ERROR
public static final ReturnCode PORT_ERROR
BUFFER_ERROR
public static final ReturnCode BUFFER_ERROR
BUFFER_FULL
public static final ReturnCode BUFFER_FULL
BUFFER_EMPTY
public static final ReturnCode BUFFER_EMPTY
BUFFER_TIMEOUT
public static final ReturnCode BUFFER_TIMEOUT
SEND_FULL
public static final ReturnCode SEND_FULL
SEND_TIMEOUT
public static final ReturnCode SEND_TIMEOUT
RECV_EMPTY
public static final ReturnCode RECV_EMPTY
RECV_TIMEOUT
public static final ReturnCode RECV_TIMEOUT
INVALID_ARGS
public static final ReturnCode INVALID_ARGS
PRECONDITION_NOT_MET
public static final ReturnCode PRECONDITION_NOT_MET
CONNECTION_LOST
public static final ReturnCode CONNECTION_LOST
UNKNOWN_ERROR
public static final ReturnCode UNKNOWN_ERROR
values
public static ReturnCode[] values()
- この列挙型の定数を含む配列を宣言されている順序で返します。
このメソッドは次のようにして定数を反復するために使用できます:
for (ReturnCode c : ReturnCode.values())
System.out.println(c);
- 戻り値:
- この列挙型の定数を宣言されている順序で含む配列
valueOf
public static ReturnCode valueOf(java.lang.String name)
- 指定した名前を持つこの型の列挙型定数を返します。
文字列は、この型の列挙型定数を宣言するのに使用した識別子と厳密に
一致している必要があります (余分な空白文字を含めることはできません)。
- パラメータ:
name
- 返される列挙型定数の名前
- 戻り値:
- 指定された名前を持つ列挙型定数
- 例外:
java.lang.IllegalArgumentException
- 指定された名前を持つ定数を
この列挙型が持っていない場合
java.lang.NullPointerException
- 引数が null の場合