Package org.openpnp.spi.base

Class AbstractFeeder

java.lang.Object

org.openpnp.model.AbstractModelObject

org.openpnp.spi.base.AbstractFeeder

All Implemented Interfaces:

Identifiable, Named, Solutions.Subject, Feeder, PropertySheetHolder, WizardConfigurable

Direct Known Subclasses:

ReferenceFeeder

public abstract class AbstractFeeder
extends AbstractModelObject
implements Feeder

Nested Class Summary

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

Feeder.FeederEmptyException, Feeder.Priority

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

PropertySheetHolder.PropertySheet

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enabled
protected int	feedRetryCount
protected java.lang.String	id
protected java.lang.String	name
protected Part	part
protected java.lang.String	partId
protected int	pickRetryCount
protected Feeder.Priority	priority
protected java.lang.Integer	retryCount	Note: This is feedRetryCount in reality.

Fields inherited from class org.openpnp.model.AbstractModelObject

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
AbstractFeeder()

Method Summary

Modifier and Type	Method	Description
boolean	canTakeBackPart()
int	getFeedRetryCount()	If feed() throws an Exception during job processing, the job processor will retry the feed() call this many times before raising the error.
java.lang.String	getId()
java.lang.String	getName()
Part	getPart()	Get the Part that is loaded into this Feeder.
int	getPickRetryCount()	If post pick checks such as isPartOn() fail during job processing, the job processor will retry the pick and check process this many times before raising the error.
Feeder.Priority	getPriority()
javax.swing.Icon	getPropertySheetHolderIcon()
PropertySheetHolder.PropertySheet[]	getPropertySheets()
boolean	isEnabled()	Return true is the Feeder is currently enabled and can be considered in Job planning.
void	postPick(Nozzle nozzle)
void	setEnabled(boolean enabled)
void	setFeedRetryCount(int feedRetryCount)
void	setName(java.lang.String name)
void	setPart(Part part)	Set the Part that is loaded into this Feeder.
void	setPickRetryCount(int pickRetryCount)
void	setPriority(Feeder.Priority priority)
void	takeBackPart(Nozzle nozzle)	Asks the feeder to take back the part currently on the nozzle.

Methods inherited from class org.openpnp.model.AbstractModelObject

addPropertyChangeListener, addPropertyChangeListener, dispose, dumpListeners, fireIndexedPropertyChange, firePropertyChange, isListener, isListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openpnp.spi.Feeder

feed, getJobPreparationLocation, getPickLocation, isPartHeightAbovePickLocation, prepareForJob

Methods inherited from interface org.openpnp.spi.PropertySheetHolder

getChildPropertySheetHolders, getPropertySheetHolderActions, getPropertySheetHolderTitle

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

findIssues, getSubjectIcon, getSubjectText

Methods inherited from interface org.openpnp.spi.WizardConfigurable

getConfigurationWizard

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

enabled

protected boolean enabled

partId

protected java.lang.String partId

retryCount

protected java.lang.Integer retryCount

Note: This is feedRetryCount in reality. It was left as retryCount for backwards compatibility when pickRetryCount was added. TODO Migration has been added and this can be removed after 2021-12-29.

feedRetryCount

protected int feedRetryCount

pickRetryCount

protected int pickRetryCount

part

protected Part part

priority

protected Feeder.Priority priority

Constructor Detail

AbstractFeeder

public AbstractFeeder()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

isEnabled

public boolean isEnabled()

Description copied from interface: Feeder

Return true is the Feeder is currently enabled and can be considered in Job planning.

Specified by:

isEnabled in interface Feeder

Returns:

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Feeder

setPart

public void setPart(Part part)

Description copied from interface: Feeder

Set the Part that is loaded into this Feeder.

Specified by:

setPart in interface Feeder

getPart

public Part getPart()

Description copied from interface: Feeder

Get the Part that is loaded into this Feeder.

Specified by:

getPart in interface Feeder

Returns:

getName

public java.lang.String getName()

Specified by:

getName in interface Named

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Named

getPropertySheetHolderIcon

public javax.swing.Icon getPropertySheetHolderIcon()

Specified by:

getPropertySheetHolderIcon in interface PropertySheetHolder

getFeedRetryCount

public int getFeedRetryCount()

Description copied from interface: Feeder

If feed() throws an Exception during job processing, the job processor will retry the feed() call this many times before raising the error.

Specified by:

getFeedRetryCount in interface Feeder

Returns:

setFeedRetryCount

public void setFeedRetryCount(int feedRetryCount)

getPickRetryCount

public int getPickRetryCount()

Description copied from interface: Feeder

If post pick checks such as isPartOn() fail during job processing, the job processor will retry the pick and check process this many times before raising the error. Note that this does not include re-feeding the part.

Specified by:

getPickRetryCount in interface Feeder

Returns:

setPickRetryCount

public void setPickRetryCount(int pickRetryCount)

getPropertySheets

public PropertySheetHolder.PropertySheet[] getPropertySheets()

Specified by:

getPropertySheets in interface PropertySheetHolder

postPick

public void postPick(Nozzle nozzle)
              throws java.lang.Exception

Specified by:

postPick in interface Feeder

Throws:

java.lang.Exception

canTakeBackPart

public boolean canTakeBackPart()

Specified by:

canTakeBackPart in interface Feeder

takeBackPart

public void takeBackPart(Nozzle nozzle)
                  throws java.lang.Exception

Description copied from interface: Feeder

Asks the feeder to take back the part currently on the nozzle.

Specified by:

takeBackPart in interface Feeder

Throws:

java.lang.Exception

getPriority

public Feeder.Priority getPriority()

Specified by:

getPriority in interface Feeder

setPriority

public void setPriority(Feeder.Priority priority)

Specified by:

setPriority in interface Feeder