com.kuka.roboticsAPI.deviceModel.kmp
Enum MovementLockSource

java.lang.Object
  java.lang.Enum<MovementLockSource>
      com.kuka.roboticsAPI.deviceModel.kmp.MovementLockSource

All Implemented Interfaces:

Serializable, Comparable<MovementLockSource>

public enum MovementLockSource
extends Enum<MovementLockSource>

An enumeration represents movement lock sources.

Enum Constant Summary

EXTERNAL_STOP
Lock source indicating an external stop.

INTERNAL_STOP
Lock source indicating an internal stop.

NO_LOCK
No lock present.

UNDEFINED_TYPE
Undefined lock source.

Method Summary

static MovementLockSource	convertFromIntValue(int sourceValue) Convert Sunrise lock source to MovementLockState.
int	getLockSourceValue() Return the number representing the lock source.
static MovementLockSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static MovementLockSource[]	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

INTERNAL_STOP

public static final MovementLockSource INTERNAL_STOP

Lock source indicating an internal stop.

EXTERNAL_STOP

public static final MovementLockSource EXTERNAL_STOP

Lock source indicating an external stop.

UNDEFINED_TYPE

public static final MovementLockSource UNDEFINED_TYPE

Undefined lock source.

NO_LOCK

public static final MovementLockSource NO_LOCK

No lock present.

Method Detail

values

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

Returns:

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

valueOf

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

getLockSourceValue

public int getLockSourceValue()

Return the number representing the lock source.

Returns:

0 - internal stop 1 - external stop -1 - undefined stop -2 - no lock present

convertFromIntValue

public static MovementLockSource convertFromIntValue(int sourceValue)

Convert Sunrise lock source to MovementLockState.

Parameters:

sourceValue - The source value.

Returns:

The corresponding source.