com.kuka.motion
Enum MotionContainerState

java.lang.Object
  java.lang.Enum<MotionContainerState>
      com.kuka.motion.MotionContainerState

All Implemented Interfaces:

Serializable, Comparable<MotionContainerState>

public enum MotionContainerState
extends Enum<MotionContainerState>

Represents the state of an IMotionContainer that tracks the execution of an IMotion, commanded by one of the methods offered by IMovable.

The initial state is CREATED. After that, the states will transition in the following order (note that at any point prior to a final state, a transition to CANCELED or ERROR might occur):

        CREATED
           |
           v
        QUEUED
           |
           v
       EXECUTING
        /  |  \
       v   |   v
  FINISHED |  ERROR
           v
       CANCELED
 

Enum Constant Summary

CANCELED
The motion execution was aborted due to a user cancel request.

CREATED
The initial state.

ERROR
There was an error while executing the motion.

EXECUTING
The motion is currently executing.

FINISHED
The motion was finished normally.

QUEUED
The motion was sent to the controller and is awaiting execution.

Method Summary

boolean	isFinal()
static MotionContainerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static MotionContainerState[]	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 MotionContainerState CREATED

The initial state. The motion is not sent to the controller.

QUEUED

public static final MotionContainerState QUEUED

The motion was sent to the controller and is awaiting execution.

EXECUTING

public static final MotionContainerState EXECUTING

The motion is currently executing.

FINISHED

public static final MotionContainerState FINISHED

The motion was finished normally.

CANCELED

public static final MotionContainerState CANCELED

The motion execution was aborted due to a user cancel request.

ERROR

public static final MotionContainerState ERROR

There was an error while executing the motion.

Method Detail

values

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

Returns:

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

valueOf

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

isFinal

public boolean isFinal()

Returns:

true if and only if the state is final, i.e. the motion container will not transition into another state.