org.openpnp.machine.reference

Class ReferenceMachine

java.lang.Object

org.openpnp.model.AbstractModelObject

org.openpnp.spi.base.AbstractMachine

org.openpnp.machine.reference.ReferenceMachine

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Solutions.Subject, Machine, PropertySheetHolder, WizardConfigurable

Direct Known Subclasses:

SimulationModeMachine

public class ReferenceMachine
extends AbstractMachine

Nested Class Summary

Nested classes/interfaces inherited from class org.openpnp.spi.base.AbstractMachine

AbstractMachine.State

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

PropertySheetHolder.PropertySheet

Field Summary

Fields

Modifier and Type	Field and Description
protected FiducialLocator	fiducialLocator
protected MotionPlanner	mootionPlanner
protected MotionPlanner	motionPlanner
protected PnpJobProcessor	pnpJobProcessor

Fields inherited from class org.openpnp.spi.base.AbstractMachine

actuators, axes, cameras, discardLocation, drivers, executor, feeders, heads, listeners, nozzleTips, partAlignments, properties, signalers, speed, taskThread

Fields inherited from class org.openpnp.model.AbstractModelObject

propertyChangeSupport

Fields inherited from interface org.openpnp.spi.Machine

DEFAULT_TASK_BUSY_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
ReferenceMachine()

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	commit()
void	findIssues(Solutions solutions) Report any detected issue and proposed solution in the list.
CalibrationSolutions	getCalibrationSolutions()
PropertySheetHolder[]	getChildPropertySheetHolders()
java.util.List<java.lang.Class<? extends Actuator>>	getCompatibleActuatorClasses()
java.util.List<java.lang.Class<? extends Axis>>	getCompatibleAxisClasses()
java.util.List<java.lang.Class<? extends Camera>>	getCompatibleCameraClasses()
java.util.List<java.lang.Class<? extends Driver>>	getCompatibleDriverClasses()
java.util.List<java.lang.Class<? extends Feeder>>	getCompatibleFeederClasses()
java.util.List<java.lang.Class<? extends MotionPlanner>>	getCompatibleMotionPlannerClasses()
java.util.List<java.lang.Class<? extends Nozzle>>	getCompatibleNozzleClasses()
java.util.List<java.lang.Class<? extends Signaler>>	getCompatibleSignalerClasses()
Wizard	getConfigurationWizard() Gets a Wizard that can be used to configure this object.
Driver	getDefaultDriver()
FiducialLocator	getFiducialLocator()
boolean	getHomeAfterEnabled()
MotionPlanner	getMotionPlanner()
PnpJobProcessor	getPnpJobProcessor()
javax.swing.Action[]	getPropertySheetHolderActions()
java.lang.String	getPropertySheetHolderTitle()
PropertySheetHolder.PropertySheet[]	getPropertySheets()
Solutions	getSolutions()
Length	getUnsafeZRoamingDistance() Virtual Z axes (typically on cameras) are invisible, therefore it can easily be overlooked by users that it is at unsafe Z.
VisionSolutions	getVisionSolutions()
void	home() Commands all Heads to perform visual homing if available.
boolean	isAutoToolSelect()
boolean	isEnabled() Returns whether the Machine is currently ready for commands.
boolean	isHomed() Returns whether the Machine is homed
boolean	isParkAfterHomed()
boolean	isPoolScriptingEngines()
boolean	isSafeZPark()
void	registerFeederClass(java.lang.Class<? extends Feeder> cls)
void	setAutoToolSelect(boolean autoToolSelect)
void	setEnabled(boolean enabled) Attempts to bring the Machine to a ready state or attempts to immediately stop it depending on the value of enabled.
void	setHomeAfterEnabled(boolean newValue)
void	setHomed(boolean isHomed)
void	setMotionPlanner(MotionPlanner motionPlanner)
void	setParkAfterHomed(boolean parkAfterHomed)
void	setPoolScriptingEngines(boolean poolScriptingEngines)
void	setSafeZPark(boolean safeZPark)
void	setUnsafeZRoamingDistance(Length unsafeZRoamingDistance)

Methods inherited from class org.openpnp.spi.base.AbstractMachine

addActuator, addAxis, addCamera, addDriver, addFeeder, addHead, addListener, addNozzleTip, addSignaler, execute, fireMachineAboutToBeDisabled, fireMachineActuatorActivity, fireMachineBusy, fireMachineDisabled, fireMachineDisableFailed, fireMachineEnabled, fireMachineEnableFailed, fireMachineHeadActivity, fireMachineHomed, fireMachineTargetedUserAction, getActuator, getActuatorByName, getActuators, getAllActuators, getAllCameras, getAxes, getAxis, getCamera, getCameras, getDefaultAxis, getDefaultHead, getDiscardLocation, getDriver, getDrivers, getFeeder, getFeederByName, getFeeders, getHead, getHeadByName, getHeads, getNozzleTip, getNozzleTipByName, getNozzleTips, getPartAlignments, getProperty, getPropertySheetHolderIcon, getSignaler, getSignalerByName, getSignalers, getSpeed, getTaskThread, isBusy, isTask, permutateActuator, permutateAxis, permutateCamera, permutateDriver, removeActuator, removeAxis, removeCamera, removeDriver, removeFeeder, removeListener, removeNozzleTip, removeSignaler, setDiscardLocation, setProperty, setSpeed, setTaskThread, submit, submit, submit, submit

Methods inherited from class org.openpnp.model.AbstractModelObject

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, firePropertyChange, 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.Machine

execute, execute, executeIfEnabled

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

getSubjectIcon, getSubjectText

Field Detail

pnpJobProcessor

protected PnpJobProcessor pnpJobProcessor

fiducialLocator

protected FiducialLocator fiducialLocator

motionPlanner

protected MotionPlanner motionPlanner

mootionPlanner

protected MotionPlanner mootionPlanner

Constructor Detail

ReferenceMachine

public ReferenceMachine()

Method Detail

commit

protected void commit()

Overrides:

commit in class AbstractMachine

getDefaultDriver

public Driver getDefaultDriver()

isEnabled

public boolean isEnabled()

Description copied from interface: Machine

Returns whether the Machine is currently ready for commands.

setEnabled

public void setEnabled(boolean enabled)
                throws java.lang.Exception

Description copied from interface: Machine

Attempts to bring the Machine to a ready state or attempts to immediately stop it depending on the value of enabled. If true, this would include turning on motor drivers, turning on compressors, resetting solenoids, etc. If the Machine is unable to become ready for any reason it should throw an Exception explaining the reason. This method should block until the Machine is ready. After this method is called successfully, isEnabled() should return true unless the Machine encounters some error. If false, stops the machine and disables it as soon as possible. This may include turning off power to motors and stopping compressors. It is expected that the machine may need to be re-homed after this is called. If the Machine cannot be stopped for any reason, this method may throw an Exception explaining the reason but this should probably only happen in very extreme cases. This method should effectively be considered a software emergency stop. After this method returns, isEnabled() should return false until setEnabled(true) is successfully called again.

Throws:

java.lang.Exception

getMotionPlanner

public MotionPlanner getMotionPlanner()

setMotionPlanner

public void setMotionPlanner(MotionPlanner motionPlanner)

isAutoToolSelect

public boolean isAutoToolSelect()

Returns:

True if the tool in machine controls should be auto-selected based on targeted user action.

setAutoToolSelect

public void setAutoToolSelect(boolean autoToolSelect)

isSafeZPark

public boolean isSafeZPark()

Returns:

True if the Z Park button should move all other HeadMountables to Safe Z.

setSafeZPark

public void setSafeZPark(boolean safeZPark)

isParkAfterHomed

public boolean isParkAfterHomed()

Returns:

True if the machine heads should be parked after the machine was homed.

setParkAfterHomed

public void setParkAfterHomed(boolean parkAfterHomed)

getUnsafeZRoamingDistance

public Length getUnsafeZRoamingDistance()

Description copied from interface: Machine

Virtual Z axes (typically on cameras) are invisible, therefore it can easily be overlooked by users that it is at unsafe Z. When they later press the Move tool to camera location button, an unexpected Z down-move will result, potentially crashing the tool. The maximum allowable roaming distance at unsafe Z therefore limits the jogging area within which an unsafe virtual Z is kept. It should be enough to fine-adjust a captured location, but jogging further away will automatically move the virtual axis to Safe Z.

Returns:

Maximum allowable roaming distance at unsafe Z.

setUnsafeZRoamingDistance

public void setUnsafeZRoamingDistance(Length unsafeZRoamingDistance)

isPoolScriptingEngines

public boolean isPoolScriptingEngines()

Returns:

True if scripting engines should be pooled for faster reuse.

setPoolScriptingEngines

public void setPoolScriptingEngines(boolean poolScriptingEngines)

getConfigurationWizard

public Wizard getConfigurationWizard()

Description copied from interface: WizardConfigurable

Gets a Wizard that can be used to configure this object.

Returns:

getPropertySheetHolderTitle

public java.lang.String getPropertySheetHolderTitle()

getChildPropertySheetHolders

public PropertySheetHolder[] getChildPropertySheetHolders()

getPropertySheetHolderActions

public javax.swing.Action[] getPropertySheetHolderActions()

getPropertySheets

public PropertySheetHolder.PropertySheet[] getPropertySheets()

registerFeederClass

public void registerFeederClass(java.lang.Class<? extends Feeder> cls)

getCompatibleAxisClasses

public java.util.List<java.lang.Class<? extends Axis>> getCompatibleAxisClasses()

getCompatibleFeederClasses

public java.util.List<java.lang.Class<? extends Feeder>> getCompatibleFeederClasses()

getCompatibleCameraClasses

public java.util.List<java.lang.Class<? extends Camera>> getCompatibleCameraClasses()

getCompatibleNozzleClasses

public java.util.List<java.lang.Class<? extends Nozzle>> getCompatibleNozzleClasses()

getCompatibleActuatorClasses

public java.util.List<java.lang.Class<? extends Actuator>> getCompatibleActuatorClasses()

getCompatibleSignalerClasses

public java.util.List<java.lang.Class<? extends Signaler>> getCompatibleSignalerClasses()

getCompatibleDriverClasses

public java.util.List<java.lang.Class<? extends Driver>> getCompatibleDriverClasses()

getCompatibleMotionPlannerClasses

public java.util.List<java.lang.Class<? extends MotionPlanner>> getCompatibleMotionPlannerClasses()

home

public void home()
          throws java.lang.Exception

Description copied from interface: Machine

Commands all Heads to perform visual homing if available. Depending on the head configuration of the machine the home positions may not all be the same but the end result should be that any head commanded to move to a certain position will end up in the same position.

Specified by:

home in interface Machine

Overrides:

home in class AbstractMachine

Throws:

java.lang.Exception

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getFiducialLocator

public FiducialLocator getFiducialLocator()

getPnpJobProcessor

public PnpJobProcessor getPnpJobProcessor()

getHomeAfterEnabled

public boolean getHomeAfterEnabled()

setHomeAfterEnabled

public void setHomeAfterEnabled(boolean newValue)

isHomed

public boolean isHomed()

Description copied from interface: Machine

Returns whether the Machine is homed

setHomed

public void setHomed(boolean isHomed)

getSolutions

public Solutions getSolutions()

getVisionSolutions

public VisionSolutions getVisionSolutions()

getCalibrationSolutions

public CalibrationSolutions getCalibrationSolutions()

findIssues

public void findIssues(Solutions solutions)

Description copied from interface: Solutions.Subject

Report any detected issue and proposed solution in the list.

Specified by:

findIssues in interface Solutions.Subject

Overrides:

findIssues in class AbstractMachine