com.kuka.roboticsAPI.controllerModel.sunrise.brakeTest
Enum BrakeState

java.lang.Object
  java.lang.Enum<BrakeState>
      com.kuka.roboticsAPI.controllerModel.sunrise.brakeTest.BrakeState

All Implemented Interfaces:

Serializable, Comparable<BrakeState>

public enum BrakeState
extends Enum<BrakeState>

The brake test of a single drive can result in one of the following states.

Enum Constant Summary

BRAKE_ERROR
The brake test failed.

BRAKE_EXCESSIVE
The measured brake holding torque exceeds the allowed maximum.

BRAKE_MAX_UNKNOWN
The brake test was successful.

BRAKE_READY
The brake test was successful.

BRAKE_UNKNOWN
The brake test couldn't be executed or was aborted.

BRAKE_UNTESTED
The brake test was not executed yet.

BRAKE_WARNING
The brake test was successful.

Method Summary

static BrakeState	fromInteger(int state) Validates and converts an integer value into a State.
abstract LogLevel	getLogLevel() Returns the logging level, which belongs to the state.
int	toInt() Converts the enumeration into an integer value.
abstract String	toString()
static BrakeState	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrakeState[]	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

BRAKE_UNTESTED

public static final BrakeState BRAKE_UNTESTED

The brake test was not executed yet.

BRAKE_UNKNOWN

public static final BrakeState BRAKE_UNKNOWN

The brake test couldn't be executed or was aborted.

BRAKE_ERROR

public static final BrakeState BRAKE_ERROR

The brake test failed. The brake is not able to hold the robot since the measured torque was smaller than the tested torque.

BRAKE_WARNING

public static final BrakeState BRAKE_WARNING

The brake test was successful. The brake is able to hold the robot and the measured torque was still in the tolerance range but almost reaches the tested torque.

BRAKE_MAX_UNKNOWN

public static final BrakeState BRAKE_MAX_UNKNOWN

The brake test was successful. The brake is able to hold the robot. Optional maximum brake holding torque is available but was not tested.

BRAKE_EXCESSIVE

public static final BrakeState BRAKE_EXCESSIVE

The measured brake holding torque exceeds the allowed maximum. The brake is able to hold the robot, but the robot can be damaged by the brake.

BRAKE_READY

public static final BrakeState BRAKE_READY

The brake test was successful. The brake is able to hold the robot.

Method Detail

values

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

Returns:

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

valueOf

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

fromInteger

public static BrakeState fromInteger(int state)

Validates and converts an integer value into a State. In case of an illegal state an IllegalArgumentException will be thrown.

Parameters:

state - is the state, which has to be validated

Returns:

The validated and converted state.

getLogLevel

public abstract LogLevel getLogLevel()

Returns the logging level, which belongs to the state.

Returns:

The logging level.

toInt

public int toInt()

Converts the enumeration into an integer value.

Returns:

The state as integer value.

toString

public abstract String toString()

Overrides:

toString in class Enum<BrakeState>