com.kuka.roboticsAPI.controllerModel.sunrise.api
Enum SSRExecutionFailureReason

java.lang.Object
  java.lang.Enum<SSRExecutionFailureReason>
      com.kuka.roboticsAPI.controllerModel.sunrise.api.SSRExecutionFailureReason

All Implemented Interfaces:

Serializable, Comparable<SSRExecutionFailureReason>

public enum SSRExecutionFailureReason
extends Enum<SSRExecutionFailureReason>

The possible failure reasons which may cause a SSR execution to not successfully execute.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Enum Constant Summary

NOT_FOUND
The requested SSR has not been found.

PROCESSING_ERROR
An error occurred during execution of a SSR.

VERSION_MISMATCH
The requested version of a SSR has not been found.

Method Summary

int	getCode() Gets the internal error code.
static SSRExecutionFailureReason	getFailureReasonFromErrorCode(int errorCode) Gets the failure reason of a SSR execution for a given error code.
static SSRExecutionFailureReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static SSRExecutionFailureReason[]	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

NOT_FOUND

public static final SSRExecutionFailureReason NOT_FOUND

The requested SSR has not been found.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

VERSION_MISMATCH

public static final SSRExecutionFailureReason VERSION_MISMATCH

The requested version of a SSR has not been found.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

PROCESSING_ERROR

public static final SSRExecutionFailureReason PROCESSING_ERROR

An error occurred during execution of a SSR.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Method Detail

values

public static SSRExecutionFailureReason[] 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 (SSRExecutionFailureReason c : SSRExecutionFailureReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static SSRExecutionFailureReason valueOf(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:

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

NullPointerException - if the argument is null

getCode

public int getCode()

Gets the internal error code.

Returns:

the error code

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getFailureReasonFromErrorCode

public static SSRExecutionFailureReason getFailureReasonFromErrorCode(int errorCode)

Gets the failure reason of a SSR execution for a given error code.

Parameters:

errorCode - the error code whose failure reason is requested

Returns:

the failure reason

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.