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

Class PumpEventPumpOp

java.lang.Object

com.tccc.kos.ext.dispense.pipeline.ingredient.ops.PumpOp

com.tccc.kos.ext.dispense.pipeline.ingredient.ops.PumpEventPumpOp

All Implemented Interfaces:

com.tccc.kos.commons.util.Abortable, com.tccc.kos.commons.util.Cancelable, com.tccc.kos.commons.util.Terminable, Cloneable

Direct Known Subclasses:

TpourOp, VpourOp

public abstract class PumpEventPumpOp
extends PumpOp

Base PumpOp class that automatically fires pump events using the PumpEventService. Any operation that needs to generate pump events should extend this base class.

Since:

1.0

Version:

2024-08-22

Nested Class Summary

Nested classes/interfaces inherited from class com.tccc.kos.ext.dispense.pipeline.ingredient.ops.PumpOp

PumpOp.Grant

Field Summary

Fields inherited from class com.tccc.kos.ext.dispense.pipeline.ingredient.ops.PumpOp

GRANT_LIMIT

Constructor Summary

Constructors

Constructor	Description
PumpEventPumpOp()

Method Summary

Modifier and Type	Method	Description
void	start(com.tccc.kos.commons.util.concurrent.future.FutureWork future)	Called when the future is started using a START callback on the future.
void	stop(com.tccc.kos.commons.util.concurrent.future.FutureWork future)	Called when the future is completed using a COMPLETE callback on the future.

Methods inherited from class com.tccc.kos.ext.dispense.pipeline.ingredient.ops.PumpOp

abort, addGrant, buildFuture, cancel, clone, getEffectiveRate, getErrorHandlerId, getEstimatedTime, getEstimatedVolume, getFuture, getGrants, getGrants, getIngredientPipelineService, getIntent, getPump, getRate, getType, isDiluted, setDiluted, setErrorHandlerId, setRate, validate

Methods inherited from class java.lang.Object

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

Constructor Details

PumpEventPumpOp

public PumpEventPumpOp()

Method Details

start

public void start(com.tccc.kos.commons.util.concurrent.future.FutureWork future)

Called when the future is started using a START callback on the future. This allows any pre-future logic to be run, and allows this logic to be inherited so that it doesn't have to be baked into every subclass buildFuture() . This allows for cross-cutting functionality. Override as needed.

Overrides:

start in class PumpOp

stop

public void stop(com.tccc.kos.commons.util.concurrent.future.FutureWork future)

Called when the future is completed using a COMPLETE callback on the future. This allows any post-future logic to run reliably without having to put the logic directly into buildFuture() . This allows for the functionality to be inherited by subclasses and allows for cross-cutting functionality. This is guaranteed to be called if start() is called. Override as needed.

Overrides:

stop in class PumpOp