AbstractHead.VisualHomingMethod

java.lang.Object
- java.lang.Enum<AbstractHead.VisualHomingMethod>
- - org.openpnp.spi.base.AbstractHead.VisualHomingMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractHead.VisualHomingMethod>

Enclosing class:

AbstractHead
```
public static enum AbstractHead.VisualHomingMethod
extends java.lang.Enum<AbstractHead.VisualHomingMethod>
```
Choice of Visual Homing Method. Previous Visual Homing reset the controller to home coordinates, not to the fiducial coordinates as one might expect. As a consequence the fiducial location may shift its meaning before/after homing i.e. it cannot be captured. This behavior has been called a bug by Jason. But we absolutely need to migrate this behavior in order not to break all the captured coordinates on a machine! As a consequence the method is now a choice. Users with new machines can select the more natural ResetToFiducialLocation method. This also applies to all Users that had the fiducial location == homing location, including those that used extra after-homing G0 X Y to make it so (like myself).

Enum Constant Summary

Enum Constants
Enum Constant Description

None

ResetToFiducialLocation

ResetToHomeLocation

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static AbstractHead.VisualHomingMethod`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static AbstractHead.VisualHomingMethod[]`	`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
  - None
```
public static final AbstractHead.VisualHomingMethod None
```
  - ResetToFiducialLocation
```
public static final AbstractHead.VisualHomingMethod ResetToFiducialLocation
```
  - ResetToHomeLocation
```
public static final AbstractHead.VisualHomingMethod ResetToHomeLocation
```
- Method Detail
  - values
```
public static AbstractHead.VisualHomingMethod[] 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 (AbstractHead.VisualHomingMethod c : AbstractHead.VisualHomingMethod.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AbstractHead.VisualHomingMethod 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