org.openpnp.spi

Enum Locatable.LocationOption

java.lang.Object

java.lang.Enum<Locatable.LocationOption>

org.openpnp.spi.Locatable.LocationOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Locatable.LocationOption>

Enclosing interface:

Locatable

public static enum Locatable.LocationOption
extends java.lang.Enum<Locatable.LocationOption>

Contains all possible options for getting approximative locations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ApplySoftLimits Apply soft limits.
KeepRotation Keep the raw Rotation coordinate as is, specified in currentLocation.
KeepX Keep the raw X coordinate as is, specified in currentLocation.
KeepY Keep the raw Y coordinate as is, specified in currentLocation.
KeepZ Keep the raw Z coordinate as is, specified in currentLocation.
Quiet Be quiet about transforms.
ReplaceVirtual Replaces virtual coordinates with the head offset.
SuppressCameraCalibration Suppress camera calibration, such as advanced camera calibration head offsets, i.e.
SuppressDynamicCompensation Suppress dynamic (i.e.
SuppressStaticCompensation Suppress static compensations, such as non-squareness compensation.

Method Summary

Modifier and Type	Method and Description
static Locatable.LocationOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Locatable.LocationOption[]	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

KeepX

public static final Locatable.LocationOption KeepX

Keep the raw X coordinate as is, specified in currentLocation.

KeepY

public static final Locatable.LocationOption KeepY

Keep the raw Y coordinate as is, specified in currentLocation.

KeepZ

public static final Locatable.LocationOption KeepZ

Keep the raw Z coordinate as is, specified in currentLocation.

KeepRotation

public static final Locatable.LocationOption KeepRotation

Keep the raw Rotation coordinate as is, specified in currentLocation.

SuppressCameraCalibration

public static final Locatable.LocationOption SuppressCameraCalibration

Suppress camera calibration, such as advanced camera calibration head offsets, i.e. tilt compensation.

SuppressStaticCompensation

public static final Locatable.LocationOption SuppressStaticCompensation

Suppress static compensations, such as non-squareness compensation.

SuppressDynamicCompensation

public static final Locatable.LocationOption SuppressDynamicCompensation

Suppress dynamic (i.e. runtime calibrated) compensations, such as NozzleTip runout compensation.

ReplaceVirtual

public static final Locatable.LocationOption ReplaceVirtual

Replaces virtual coordinates with the head offset.

ApplySoftLimits

public static final Locatable.LocationOption ApplySoftLimits

Apply soft limits.

Quiet

public static final Locatable.LocationOption Quiet

Be quiet about transforms.

Method Detail

values

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

Returns:

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

valueOf

public static Locatable.LocationOption valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null