com.kuka.nav.robot
Enum CollisionAvoidanceState

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

All Implemented Interfaces:

Serializable, Comparable<CollisionAvoidanceState>

public enum CollisionAvoidanceState
extends Enum<CollisionAvoidanceState>

Enumeration to hold information about the collision avoidance running on the robot.

Enum Constant Summary

NOT_INFLUENCING
state indicating that the colli is currently not influencing.

SLOWING_DOWN
state indicating that the colli is currently slowing down the robot.

STOPPING
state indicating that the colli is currently stopping the robot.

UNDEFINED
state indicating an undefined colli state.

Method Summary

static CollisionAvoidanceState	fromTypeId(int id) Gets the stop condition defined through the given id.
int	getId() Gets the id of the stop condition.
String	getTypeName() Gets the name of the robot.
static CollisionAvoidanceState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CollisionAvoidanceState[]	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

NOT_INFLUENCING

public static final CollisionAvoidanceState NOT_INFLUENCING

state indicating that the colli is currently not influencing.

SLOWING_DOWN

public static final CollisionAvoidanceState SLOWING_DOWN

state indicating that the colli is currently slowing down the robot.

STOPPING

public static final CollisionAvoidanceState STOPPING

state indicating that the colli is currently stopping the robot.

UNDEFINED

public static final CollisionAvoidanceState UNDEFINED

state indicating an undefined colli state.

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

Gets the id of the stop condition.

Returns:

The id of the stop condition.

getTypeName

public String getTypeName()

Gets the name of the robot.

Returns:

The name of the robot.

fromTypeId

public static CollisionAvoidanceState fromTypeId(int id)

Gets the stop condition defined through the given id. Fails if no mode could be found.

Parameters:

id - The id.

Returns:

The matching enum type.