com.kuka.roboticsAPI.executionModel
Enum ExecutionState

java.lang.Object
  java.lang.Enum<ExecutionState>
      com.kuka.roboticsAPI.executionModel.ExecutionState

All Implemented Interfaces:

Serializable, Comparable<ExecutionState>

public enum ExecutionState
extends Enum<ExecutionState>

Execution container states.

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

ApplicationExit
The application is exiting; execution services are being disposed.

Cancelled
The container execution was stopped due to a user cancel request.

Created
The first state.

Executing
The container is currently executing.

ExternalStop
The container execution was stopped due to an external signal.

Finished
The container has finished it's execution.

FinishedAwaitingRecoveryInfo
The container has finished it's execution, but is awaiting the recovery information.

Invalid
There was an error during execution of the container.

Queued
The container is at the controller and waits for it's execution.

Recovering
The container is trying to recover from an error.

Method Summary

static ExecutionState	fromId(int commandId) Creates a navigation command state out of the given id.
int	getId() Value getter for enum.
boolean	isError() Determines if this state is an error state.
boolean	isFinished() Determines if this state is finished.
boolean	isFinishedOrAwaitingRecovery() Determines if this state is finished.
static ExecutionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionState[]	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

Created

public static final ExecutionState Created

The first state. Container is created, but not sent to the controller yet.

Queued

public static final ExecutionState Queued

The container is at the controller and waits for it's execution.

Executing

public static final ExecutionState Executing

The container is currently executing.

Recovering

public static final ExecutionState Recovering

The container is trying to recover from an error.

FinishedAwaitingRecoveryInfo

public static final ExecutionState FinishedAwaitingRecoveryInfo

The container has finished it's execution, but is awaiting the recovery information.

Finished

public static final ExecutionState Finished

The container has finished it's execution.

Cancelled

public static final ExecutionState Cancelled

The container execution was stopped due to a user cancel request.

ExternalStop

public static final ExecutionState ExternalStop

The container execution was stopped due to an external signal.

ApplicationExit

public static final ExecutionState ApplicationExit

The application is exiting; execution services are being disposed.

Invalid

public static final ExecutionState Invalid

There was an error during execution of the container.

Method Detail

values

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

Returns:

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

valueOf

public static ExecutionState 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

isFinished

public boolean isFinished()

Determines if this state is finished.

Returns:

True if this state is finished.

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.

isFinishedOrAwaitingRecovery

public boolean isFinishedOrAwaitingRecovery()

Determines if this state is finished.

Returns:

True if this state is finished.

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.

isError

public boolean isError()

Determines if this state is an error state.

Returns:

True if this state is an error state.

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.

getId

public int getId()

Value getter for enum.

Returns:

the id of the enum instance.

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.

fromId

public static ExecutionState fromId(int commandId)

Creates a navigation command state out of the given id.

Parameters:

commandId - The id of the command state within the navigation system.

Returns:

The NavigationCommandState enum member.

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.