com.kuka.nav.command
Enum NavExecutionState

java.lang.Object
  java.lang.Enum<NavExecutionState>
      com.kuka.nav.command.NavExecutionState

All Implemented Interfaces:

com.kuka.command.IExecutionState<NavExecutionState>, Serializable, Comparable<NavExecutionState>

public enum NavExecutionState
extends Enum<NavExecutionState>
implements com.kuka.command.IExecutionState<NavExecutionState>

Represents state of a navigation command execution.

Enum Constant Summary

AWAITING_BLENDING
The container is waiting because of blending configuration.

CREATED
Container is created (constructor is called), but not sent to the mobile robot yet.

EXECUTING
The container is currently executing.

FINALIZED
The container has finished its execution and does not influence the robot's pose.

FINISHED
The container has finished its execution but still can influence the robot's pose.

INITIAL
First state, container is ready to be created.

QUEUED
The container was sent to the mobile robot and waits for it's execution.

RECOVERING
The container is trying to recover from an error.

Method Summary

boolean	isAwaitingBlending() Command (responsible execution container) was executed, but it is waiting because of blending configuration.
boolean	isExecuting()
boolean	isFinalized()
boolean	isFinished()
boolean	isQueued()
boolean	isRecovering() Command (responsible execution container) is recovering from an error.
static NavExecutionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static NavExecutionState[]	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

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

INITIAL

public static final NavExecutionState INITIAL

First state, container is ready to be created.

CREATED

public static final NavExecutionState CREATED

Container is created (constructor is called), but not sent to the mobile robot yet.

QUEUED

public static final NavExecutionState QUEUED

The container was sent to the mobile robot and waits for it's execution.

EXECUTING

public static final NavExecutionState EXECUTING

The container is currently executing.

RECOVERING

public static final NavExecutionState RECOVERING

The container is trying to recover from an error.

AWAITING_BLENDING

public static final NavExecutionState AWAITING_BLENDING

The container is waiting because of blending configuration.

FINISHED

public static final NavExecutionState FINISHED

The container has finished its execution but still can influence the robot's pose.

Note: This does not say anything about the result of the command, but only about it's state of execution.

FINALIZED

public static final NavExecutionState FINALIZED

The container has finished its execution and does not influence the robot's pose.

Note: This does not say anything about the result of the command, but only about it's state of execution.

Method Detail

values

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

Returns:

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

valueOf

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

isQueued

public boolean isQueued()

Specified by:

isQueued in interface com.kuka.command.IExecutionState<NavExecutionState>

isExecuting

public boolean isExecuting()

Specified by:

isExecuting in interface com.kuka.command.IExecutionState<NavExecutionState>

isRecovering

public boolean isRecovering()

Command (responsible execution container) is recovering from an error.

Returns:

true if command is recovering.

isAwaitingBlending

public boolean isAwaitingBlending()

Command (responsible execution container) was executed, but it is waiting because of blending configuration.

Returns:

true if command is awaiting blending.

isFinished

public boolean isFinished()

Specified by:

isFinished in interface com.kuka.command.IExecutionState<NavExecutionState>

isFinalized

public boolean isFinalized()

Specified by:

isFinalized in interface com.kuka.command.IExecutionState<NavExecutionState>