org.openpnp.machine.reference

Class ReferencePnpJobProcessor.PlannedPlacementStep

java.lang.Object

org.openpnp.machine.reference.ReferencePnpJobProcessor.PlannedPlacementStep

Direct Known Subclasses:

ReferencePnpJobProcessor.Align, ReferencePnpJobProcessor.CalibrateNozzleTips, ReferencePnpJobProcessor.ChangeNozzleTips, ReferencePnpJobProcessor.Pick, ReferencePnpJobProcessor.Place

Enclosing class:

ReferencePnpJobProcessor

protected abstract class ReferencePnpJobProcessor.PlannedPlacementStep
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<PnpJobPlanner.PlannedPlacement>	plannedPlacements

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlannedPlacementStep(java.util.List<PnpJobPlanner.PlannedPlacement> plannedPlacements)

Method Summary

Modifier and Type	Method and Description
org.openpnp.machine.reference.ReferencePnpJobProcessor.Step	step() Find the next uncompleted, non-errored PlannedPlacement and pass it to stepImpl.
protected abstract org.openpnp.machine.reference.ReferencePnpJobProcessor.Step	stepImpl(PnpJobPlanner.PlannedPlacement plannedPlacement) Process the step for the given planned placement.

Methods inherited from class java.lang.Object

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

Field Detail

plannedPlacements

protected final java.util.List<PnpJobPlanner.PlannedPlacement> plannedPlacements

Constructor Detail

PlannedPlacementStep

protected PlannedPlacementStep(java.util.List<PnpJobPlanner.PlannedPlacement> plannedPlacements)

Method Detail

stepImpl

protected abstract org.openpnp.machine.reference.ReferencePnpJobProcessor.Step stepImpl(PnpJobPlanner.PlannedPlacement plannedPlacement)
                                                                                 throws JobProcessor.JobProcessorException

Process the step for the given planned placement. The method should perform everything that needs to be done with that planned placement before returning. If there is an error that must be handled by the user in real time the method may throw PnpJobProcessorException. If there is an unrecoverable error with a placement the method should setError() on the JobPlacement.

Parameters:

plannedPlacement - The plannedPlacement to process, or null if there are no more to process. Null is a special case which means "Return the next step."

Returns:

Throws:

JobProcessorException

JobProcessor.JobProcessorException

step

public org.openpnp.machine.reference.ReferencePnpJobProcessor.Step step()
                                                                 throws JobProcessor.JobProcessorException

Find the next uncompleted, non-errored PlannedPlacement and pass it to stepImpl. If stepImpl completes without error the PlannedPlacement is marked complete and control is returned to the caller.

Throws:

JobProcessor.JobProcessorException