jp.go.aist.rtm.RTC.port
Enum ReturnCode

java.lang.Object
  java.lang.Enum<ReturnCode>
      jp.go.aist.rtm.RTC.port.ReturnCode

All Implemented Interfaces:

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.

Enum Constant Summary

BUFFER_EMPTY

BUFFER_ERROR

BUFFER_FULL

BUFFER_TIMEOUT

CONNECTION_LOST

INVALID_ARGS

PORT_ERROR

PORT_OK

PRECONDITION_NOT_MET

RECV_EMPTY

RECV_TIMEOUT

SEND_FULL

SEND_TIMEOUT

UNKNOWN_ERROR

Method Summary

static ReturnCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReturnCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

Method Detail

values

public static ReturnCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReturnCode c : ReturnCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReturnCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null