com.kuka.nav.command
Enum MapZoneInfluence

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

All Implemented Interfaces:

Serializable, Comparable<MapZoneInfluence>

public enum MapZoneInfluence
extends Enum<MapZoneInfluence>

Info whether a map zone is currently influencing a motion.

Enum Constant Summary

ERROR
An error occurred trying to influence the robot's motion because of an interfering map zone.

NOT_INFLUENCING
No map zone is influencing the robot's motion.

SLOWING_DOWN
The robot was slowed down approaching a map zone.

STOP_APPROACHING_MAPZONE
The robot was stopped approaching a map zone.

STOP_INSIDE_MAPZONE
The robot stopped inside a map zone.

UNKNOWN
State is unknown.

Method Summary

static MapZoneInfluence	fromName(String name) Creates the error type from the given name.
String	getName() Returns the name of this map zone info.
String	toString()
static MapZoneInfluence	valueOf(String name) Returns the enum constant of this type with the specified name.
static MapZoneInfluence[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final MapZoneInfluence UNKNOWN

State is unknown.

STOP_INSIDE_MAPZONE

public static final MapZoneInfluence STOP_INSIDE_MAPZONE

The robot stopped inside a map zone.

STOP_APPROACHING_MAPZONE

public static final MapZoneInfluence STOP_APPROACHING_MAPZONE

The robot was stopped approaching a map zone.

SLOWING_DOWN

public static final MapZoneInfluence SLOWING_DOWN

The robot was slowed down approaching a map zone.

ERROR

public static final MapZoneInfluence ERROR

An error occurred trying to influence the robot's motion because of an interfering map zone.

NOT_INFLUENCING

public static final MapZoneInfluence NOT_INFLUENCING

No map zone is influencing the robot's motion.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Returns the name of this map zone info.

Returns:

the name of this map zone info

toString

public String toString()

Overrides:

toString in class Enum<MapZoneInfluence>

fromName

public static MapZoneInfluence fromName(String name)

Creates the error type from the given name.

Parameters:

name - the name

Returns:

the error type