com.kuka.roboticsAPI.deviceModel.kmp
Enum MobilePlatformLockManager

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

All Implemented Interfaces:

Serializable, Comparable<MobilePlatformLockManager>

public enum MobilePlatformLockManager
extends Enum<MobilePlatformLockManager>

A singleton responsible for mobile platform lock events.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Enum Constant Summary

INSTANCE
A singleton instance of the class.

Method Summary

void	lockAllMotions() Locks all motions.
void	lockProgrammedMotions() Locks programmed motions.
void	setMovementLockListener(IMovementLockListener movementLockListener) Sets the movement lock listener.
void	unlockAllMotions() Unlocks all motions.
void	unlockProgrammedMotions() Unlocks programmed motions.
static MobilePlatformLockManager	valueOf(String name) Returns the enum constant of this type with the specified name.
static MobilePlatformLockManager[]	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

INSTANCE

public static final MobilePlatformLockManager INSTANCE

A singleton instance of the class.

Method Detail

values

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

Returns:

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

valueOf

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

setMovementLockListener

public void setMovementLockListener(IMovementLockListener movementLockListener)

Sets the movement lock listener.

Parameters:

movementLockListener - A movement lock listener instance.

lockProgrammedMotions

public void lockProgrammedMotions()

Locks programmed motions.

unlockProgrammedMotions

public void unlockProgrammedMotions()

Unlocks programmed motions.

lockAllMotions

public void lockAllMotions()

Locks all motions.

unlockAllMotions

public void unlockAllMotions()

Unlocks all motions.