com.kuka.nav.robot
Enum SafetyState

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

All Implemented Interfaces:

Serializable, Comparable<SafetyState>

public enum SafetyState
extends Enum<SafetyState>

Represents the safety states of a mobile robot.

Enum Constant Summary

ACKNOWLEDGE_REQUIRED
Acknowledge required state is active.

EMERGENCY_STOP
Emergency stop is active.

PROTECTIVE_STOP
Protective stop is active (usually caused by a laser safety field violation).

SAFE
Everything is ok.

WARNING_FIELD
A warning field is active (usually caused by a laser warning field violation).

Method Summary

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

SAFE

public static final SafetyState SAFE

Everything is ok.

WARNING_FIELD

public static final SafetyState WARNING_FIELD

A warning field is active (usually caused by a laser warning field violation). The speed of the robot is reduced.

PROTECTIVE_STOP

public static final SafetyState PROTECTIVE_STOP

Protective stop is active (usually caused by a laser safety field violation). The robot is stopped but can continue as soon as the condition is resolved (i.e. the state is SAFE again).

ACKNOWLEDGE_REQUIRED

public static final SafetyState ACKNOWLEDGE_REQUIRED

Acknowledge required state is active. The platform is stopped and the currently active actions are paused. An acknowledge is needed for being able to command new actions or continue the currently active actions.

EMERGENCY_STOP

public static final SafetyState EMERGENCY_STOP

Emergency stop is active. The platform is stopped and the currently active actions are canceled. No new action can be commanded until the condition is resolved (i.e. the state is SAFE again).

Method Detail

values

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

Returns:

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

valueOf

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