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>
@brief 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.
メソッドの概要 |
static ReturnCode |
valueOf(java.lang.String name)
指定した名前を持つこの型の列挙型定数を返します。
文字列は、この型の列挙型定数を宣言するのに使用した識別子と厳密に
一致している必要があります (余分な空白文字を含めることはできません)。 |
static ReturnCode[] |
values()
この列挙型の定数を含む配列を宣言されている順序で返します。
このメソッドは次のようにして定数を反復するために使用できます: |
クラス java.lang.Enum から継承されたメソッド |
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
クラス java.lang.Object から継承されたメソッド |
finalize, 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 final ReturnCode[] values()
- この列挙型の定数を含む配列を宣言されている順序で返します。
このメソッドは次のようにして定数を反復するために使用できます:
for(ReturnCode c : ReturnCode.values())
System.out.println(c);
- 戻り値:
- この列挙型の定数を宣言されている順序で含む配列
valueOf
public static ReturnCode valueOf(java.lang.String name)
- 指定した名前を持つこの型の列挙型定数を返します。
文字列は、この型の列挙型定数を宣言するのに使用した識別子と厳密に
一致している必要があります (余分な空白文字を含めることはできません)。
- パラメータ:
name
- 返される列挙型定数の名前
- 戻り値:
- 指定された名前を持つ列挙型定数
- 例外:
java.lang.IllegalArgumentException
- 指定された名前を持つ定数を
この列挙型が持っていない場合