com.kuka.nav.robot
Enum CommandableState

java.lang.Object
  java.lang.Enum<CommandableState>
      com.kuka.nav.robot.CommandableState

All Implemented Interfaces:

Serializable, Comparable<CommandableState>

public enum CommandableState
extends Enum<CommandableState>

Represents the commandability of the mobile robot using traffic light colors: "RED" in case of internal error, "YELLOW" in case of a paused system and "GREEN" if the robot can execute commands.

Enum Constant Summary

COMMANDABLE
The mobile robot is able to execute incoming commands.

NOT_COMMANDABLE
The mobile robot has an internal error.

TEMPORARILY_NOT_COMMANDABLE
The mobile robot is paused, and it will not execute incoming commands.

Method Summary

String	getDisplayName() Returns a language dependent display name for this state.
static CommandableState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandableState[]	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

COMMANDABLE

public static final CommandableState COMMANDABLE

The mobile robot is able to execute incoming commands.

TEMPORARILY_NOT_COMMANDABLE

public static final CommandableState TEMPORARILY_NOT_COMMANDABLE

The mobile robot is paused, and it will not execute incoming commands.

NOT_COMMANDABLE

public static final CommandableState NOT_COMMANDABLE

The mobile robot has an internal error. New commands will not be executed.

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public String getDisplayName()

Returns a language dependent display name for this state.

Returns:

a language dependent display name for this state