com.kuka.roboticsAPI.deviceModel
Enum OperationMode

java.lang.Object
  java.lang.Enum<OperationMode>
      com.kuka.roboticsAPI.deviceModel.OperationMode

All Implemented Interfaces:

Serializable, Comparable<OperationMode>

public enum OperationMode
extends Enum<OperationMode>

Represents the available operation modes.

Enum Constant Summary

AUT
Operation mode AUT was selected.

KRF
Operation mode KRF was selected.

T1
Operation mode T1 was selected.

T2
Operation mode T2 was selected.

Unknown
No operation mode was selected or unknown.

Method Summary

static OperationMode	fromInt(int id) Gets the operation mode defined through the given ID.
static OperationMode	fromName(String name) Gets the operation mode defined through the given name.
boolean	isModeAuto() Check if operation mode is AUT.
boolean	isModeKRF() Check if operation mode is KRF.
boolean	isModeT1() Check if operation mode is T1.
boolean	isModeT2() Check if operation mode is T2.
boolean	isModeUnknown() Check if operation mode is unknown.
boolean	isReducedSpeedTestMode() Checks if the mode is a test operation mode with reduced maximum speeds.
boolean	isTestMode() Checks if the mode is a test operation mode.
int	toInt() Gets the id of the operation mode.
String	toString()
static OperationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OperationMode[]	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 OperationMode Unknown

No operation mode was selected or unknown.

T1

public static final OperationMode T1

Operation mode T1 was selected.

T2

public static final OperationMode T2

Operation mode T2 was selected.

AUT

public static final OperationMode AUT

Operation mode AUT was selected.

KRF

public static final OperationMode KRF

Operation mode KRF was selected.

This element is not in its final state and might change in future versions.

Method Detail

values

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

Returns:

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

valueOf

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

toInt

public int toInt()

Gets the id of the operation mode.

Returns:

The id of the operation mode.

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.

isModeUnknown

public boolean isModeUnknown()

Check if operation mode is unknown.

Returns:

True if mode is unknown.

isModeT1

public boolean isModeT1()

Check if operation mode is T1.

Returns:

True if mode is T1.

isModeT2

public boolean isModeT2()

Check if operation mode is T2.

Returns:

True if mode is T2.

isModeAuto

public boolean isModeAuto()

Check if operation mode is AUT.

Returns:

True if mode is AUT.

isModeKRF

public boolean isModeKRF()

Check if operation mode is KRF.

Returns:

True if mode is KRF.

This element is not in its final state and might change in future versions.

isTestMode

public boolean isTestMode()

Checks if the mode is a test operation mode.

Returns:

True if the mode is a test operation mode.

isReducedSpeedTestMode

public boolean isReducedSpeedTestMode()

Checks if the mode is a test operation mode with reduced maximum speeds.

Returns:

True if the mode is a test operation mode with reduced maximum speeds.

toString

public String toString()

Overrides:

toString in class Enum<OperationMode>

fromInt

public static OperationMode fromInt(int id)

Gets the operation mode defined through the given ID. Fails if no mode could be found.

Parameters:

id - The id.

Returns:

The matching enum type.

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.

fromName

public static OperationMode fromName(String name)

Gets the operation mode defined through the given name. Fails if no mode could be found.

Parameters:

name - The name.

Returns:

The matching enum type.