com.kuka.roboticsAPI.deviceModel.kmp
Enum MovementLockType

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

All Implemented Interfaces:

Serializable, Comparable<MovementLockType>

public enum MovementLockType
extends Enum<MovementLockType>

Enum to represent platform lock states.

Enum Constant Summary

FULL_MOTION_LOCK
Full motion lock state.

PROGRAMMED_MOTION_LOCK
Programmed motion lock state.

UNDEFINED
Undefined lock state.

UNLOCKED
Unlocked state.

Method Summary

static MovementLockType	convertFromIntValue(int lockType) Convert Sunrise lock state to MovementLockState.
int	getLockTypeValue() Returns the integer representation of a lock state.
static MovementLockType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MovementLockType[]	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

UNDEFINED

public static final MovementLockType UNDEFINED

Undefined lock state.

UNLOCKED

public static final MovementLockType UNLOCKED

Unlocked state. Platform can perform any kind of movement commands.

PROGRAMMED_MOTION_LOCK

public static final MovementLockType PROGRAMMED_MOTION_LOCK

Programmed motion lock state. Platform can perform jog motions, but cannot be commanded by application motions.

FULL_MOTION_LOCK

public static final MovementLockType FULL_MOTION_LOCK

Full motion lock state. Programmed is locked agains any kind of motion.

Method Detail

values

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

Returns:

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

valueOf

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

getLockTypeValue

public int getLockTypeValue()

Returns the integer representation of a lock state.

Returns:

The integer value to be set for lock state.

convertFromIntValue

public static MovementLockType convertFromIntValue(int lockType)

Convert Sunrise lock state to MovementLockState.

Parameters:

lockType - The state value.

Returns:

The corresponding state.