org.openpnp.spi

Interface PartAlignment

All Superinterfaces:

Identifiable, Named, PartSettingsHolder, PropertySheetHolder, Solutions.Subject

All Known Implementing Classes:

AbstractPartAlignment, ReferenceBottomVision

public interface PartAlignment
extends PartSettingsHolder, Named, Solutions.Subject, PropertySheetHolder

A method to allow after-pick, pre-place alignment of parts on the nozzle. Bottom vision is an implementation of this interface, but other implementations could include laser alignment or pit alignment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PartAlignment.PartAlignmentOffset

Nested classes/interfaces inherited from interface org.openpnp.spi.PropertySheetHolder

PropertySheetHolder.PropertySheet

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(PartSettingsHolder partSettingsHolder, boolean allowDisabled)
PartAlignment.PartAlignmentOffset	findOffsets(Part part, BoardLocation boardLocation, Location placementLocation, Nozzle nozzle) Perform the part alignment operation.
Wizard	getPartConfigurationWizard(PartSettingsHolder partSettingsHolder) Get a Wizard for configuring the PartAlignment instance properties for a specific PartSettingsHolder (Part or Package).
boolean	isEnabled()

Methods inherited from interface org.openpnp.model.PartSettingsHolder

generalizeBottomVisionSettings, generalizeFiducialVisionSettings, getBottomVisionSettings, getFiducialVisionSettings, getShortName, getSpecializedBottomVisionIn, getSpecializedFiducialVisionIn, setBottomVisionSettings, setFiducialVisionSettings

Methods inherited from interface org.openpnp.model.Identifiable

getId

Methods inherited from interface org.openpnp.model.Named

getName, setName

Methods inherited from interface org.openpnp.model.Solutions.Subject

findIssues, getSubjectIcon, getSubjectText

Methods inherited from interface org.openpnp.spi.PropertySheetHolder

getChildPropertySheetHolders, getPropertySheetHolderActions, getPropertySheetHolderIcon, getPropertySheetHolderTitle, getPropertySheets

Method Detail

findOffsets

PartAlignment.PartAlignmentOffset findOffsets(Part part,
                                              BoardLocation boardLocation,
                                              Location placementLocation,
                                              Nozzle nozzle)
                                       throws java.lang.Exception

Perform the part alignment operation. The method must return a Location containing the offsets on the nozzle of the aligned part and these offsets will be applied by the JobProcessor. The offsets returned may be zero if the alignment process results in physical alignment of the part as in the case of pit based alignment. The Z portion of the Location is ignored.

Parameters:

part -

nozzle -

Returns:

Throws:

java.lang.Exception - if the alignment fails for any reason. The caller may retry.

getPartConfigurationWizard

Wizard getPartConfigurationWizard(PartSettingsHolder partSettingsHolder)

Get a Wizard for configuring the PartAlignment instance properties for a specific PartSettingsHolder (Part or Package).

Parameters:

partSettingsHolder -

Returns:

canHandle

boolean canHandle(PartSettingsHolder partSettingsHolder,
                  boolean allowDisabled)

isEnabled

boolean isEnabled()