Package com.tccc.kos.ext.dispense.pipeline.ingredient

Interface PumpIntentListener

All Superinterfaces:
IngredientPipelineListener
public interface PumpIntentListener extends IngredientPipelineListener
Listener for when a PumpIntent starts and stops. an intent is constructed from a sequence of PumpOp operations. This interface only provides information about the overall intent. For events on every PumpOp, use PumpOpListener.
Since:
1.0
Version:
2024-01-08

  • Method Details

    • onPumpIntentStart

      void onPumpIntentStart(IngredientNozzlePipeline pipeline, Pump<?> pump, PumpIntent intent, com.tccc.kos.commons.util.concurrent.future.FutureWork f)
      Called when a pump intent is about to start. The future contains a unique id that can be used to match the corresponding call to onPumpIntentStop() if needed.
      Parameters:
      pipeline - the pipeline generating the event
      pump - the pump performing the intent
      intent - the intent being performed
      f - the associated future

    • onPumpIntentStop

      void onPumpIntentStop(IngredientNozzlePipeline pipeline, Pump<?> pump, PumpIntent intent, com.tccc.kos.commons.util.concurrent.future.FutureWork f)
      Called when a pump intent is done. The end state of the future indicates whether the intent was successful or not.
      Parameters:
      pipeline - the pipeline generating the event
      pump - the pump performing the intent
      intent - the intent being performed
      f - the associated future