com.kuka.roboticsAPI.controllerModel.sunrise.positionMastering
Enum PositionRange

java.lang.Object
  java.lang.Enum<PositionRange>
      com.kuka.roboticsAPI.controllerModel.sunrise.positionMastering.PositionRange

All Implemented Interfaces:

Serializable, Comparable<PositionRange>

public enum PositionRange
extends Enum<PositionRange>

Defines the different possible position range states.

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

MASTERING_RANGE
Drive is located at the alignment element.

NEGATIVE_BARRIER
Drive stands in the negative barrier.

NEGATIVE_RANGE
Drive is located in the area defined by the mathematically negative direction of rotation and the alignment element.

POSITIVE_BARRIER
Drive stands in the positive barrier.

POSITIVE_RANGE
Drive is located in the area defined by the mathematically positive direction of rotation and the alignment element.

UNKNOWN_RANGE
Current range is unknown. => It is necessary to move the axis in order to determine the current position range.

Method Summary

static PositionRange	getNextNegativeRange(PositionRange currentPositionRange) Returns the next range in negative turning direction.
static PositionRange	getNextPositiveRange(PositionRange currentPositionRange) Returns the next range in positive turning direction.
int	getStateId()
static PositionRange	valueOf(int state) Returns the PositionRange representation of the position range state given as integer.
static int	valueOf(PositionRange positionRange) Return the int representation of the given PositionRange.
static PositionRange	valueOf(String name) Returns the enum constant of this type with the specified name.
static PositionRange[]	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

POSITIVE_BARRIER

public static final PositionRange POSITIVE_BARRIER

Drive stands in the positive barrier.

POSITIVE_RANGE

public static final PositionRange POSITIVE_RANGE

Drive is located in the area defined by the mathematically positive direction of rotation and the alignment element.

MASTERING_RANGE

public static final PositionRange MASTERING_RANGE

Drive is located at the alignment element.

NEGATIVE_RANGE

public static final PositionRange NEGATIVE_RANGE

Drive is located in the area defined by the mathematically negative direction of rotation and the alignment element.

NEGATIVE_BARRIER

public static final PositionRange NEGATIVE_BARRIER

Drive stands in the negative barrier.

UNKNOWN_RANGE

public static final PositionRange UNKNOWN_RANGE

Current range is unknown. => It is necessary to move the axis in order to determine the current position range.

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static PositionRange valueOf(int state)
                             throws PositionRangeException

Returns the PositionRange representation of the position range state given as integer.

Parameters:

state - the position range state given as integer.

Returns:

PositionRange representation of the position range state given as integer.

Throws:

PositionRangeException - if the state could not be mapped to a range

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.

valueOf

public static int valueOf(PositionRange positionRange)

Return the int representation of the given PositionRange.

Parameters:

positionRange - The given PositionRange.

Returns:

Returns int representation of the given PositionRange.

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.

getNextPositiveRange

public static PositionRange getNextPositiveRange(PositionRange currentPositionRange)

Returns the next range in positive turning direction. The function returns 'null' if the current range is POSITIVE_BARRIER.

Parameters:

currentPositionRange - The current PositionRange.

Returns:

Returns the next range in positive turning direction. The function returns 'null' if the current range is PositionRange#PositiveBarrier.

getNextNegativeRange

public static PositionRange getNextNegativeRange(PositionRange currentPositionRange)

Returns the next range in negative turning direction. The function returns 'null' if the current range is NEGATIVE_BARRIER.

Parameters:

currentPositionRange - The current PositionRange.

Returns:

Returns the next range in negative turning direction. The function returns 'null' if the current range is PositionRange#NegativeBarrier.

getStateId

public int getStateId()