Package com.tccc.kos.ext.freestyle.pipeline.beverage

Class FreestyleBeveragePourEngine

java.lang.Object

com.tccc.kos.ext.dispense.pipeline.beverage.BeveragePourEngine<FreestyleBeveragePourEngineConfig>

com.tccc.kos.ext.freestyle.pipeline.beverage.FreestyleBeveragePourEngine

All Implemented Interfaces:

ConfigAware<FreestyleBeveragePourEngineConfig>, HandleAware, TimeChangeListener, TimeListener, IngredientChangeListener, InsertionListener, InsertionPumpListener, NozzleAvailabilityListener, BrandSetServiceListener, GrantPropertiesListener

@ApiController(base="/engine",
               title="Pour engine",
               desc="Pour engine specific endpoints.")
public class FreestyleBeveragePourEngine
extends BeveragePourEngine<FreestyleBeveragePourEngineConfig>
implements TimeChangeListener, GrantPropertiesListener

Freestyle implementation of BeveragePourEngine.

Since:

1.0

Version:

2023-07-29

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEV_ID_CARB
static final String	BEV_ID_WATER

Constructor Summary

Constructors

Constructor	Description
FreestyleBeveragePourEngine(VmFsmAware board)	Create a new pour engine that uses the specified FSM and VM.

Method Summary

Modifier and Type	Method	Description
FutureWork	buildFuture(Pourable pourable)
Pourable	getPourable(String definition)
RecipeWaterType	getWaterType(Pourable pourable)	Return the water type of the specified pourable.
void	hideCarbWaterBeverage(boolean hide)	Hide carb water as a beverage.
void	hidePlainWaterBeverage(boolean hide)	Hide plain water as a beverage.
boolean	isPourable(Pourable pourable)
void	onGrantPropertiesChange(BrandSetService service)	Called when BrandSetService is provided with new grant properties, which can be accessed by getGrantProperties() .
void	onTimeChanged()
void	rebuildGraph(BevGraphBuilder builder)
void	start()
void	stop()

Methods inherited from class com.tccc.kos.ext.dispense.pipeline.beverage.BeveragePourEngine

addOverride, addOverride, asyncRebuildGraph, getBeverageNode, getConfig, getGraph, getHandle, getIngredientNode, getIngredientService, getNozzle, getPipeline, isAvailable, isAvailable, notifyChanges, onAvailabilityChange, onConfigChanged, onContainerInserted, onContainerRemoved, onIngredientChange, onNozzleAvailabilityChange, onRebuildGraph, removeOverride, removeOverride, setConfig, startPump, startPumps, stopPump, stopPumps

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tccc.kos.commons.core.service.config.ConfigAware

onConfigSet

Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

addHandleChild, getName, getPath

Field Details

BEV_ID_WATER

public static final String BEV_ID_WATER

See Also:

• Constant Field Values

BEV_ID_CARB

public static final String BEV_ID_CARB

See Also:

• Constant Field Values

Constructor Details

FreestyleBeveragePourEngine

public FreestyleBeveragePourEngine(VmFsmAware board)

Create a new pour engine that uses the specified FSM and VM.

Method Details

start

public void start()

Specified by:

start in class BeveragePourEngine<FreestyleBeveragePourEngineConfig>

stop

public void stop()

Specified by:

stop in class BeveragePourEngine<FreestyleBeveragePourEngineConfig>

rebuildGraph

public void rebuildGraph(BevGraphBuilder builder)

Specified by:

rebuildGraph in class BeveragePourEngine<FreestyleBeveragePourEngineConfig>

getPourable

public Pourable getPourable(String definition)
                     throws Exception

Specified by:

getPourable in class BeveragePourEngine<FreestyleBeveragePourEngineConfig>

Throws:

Exception

isPourable

public boolean isPourable(Pourable pourable)

Specified by:

isPourable in class BeveragePourEngine<FreestyleBeveragePourEngineConfig>

buildFuture

public FutureWork buildFuture(Pourable pourable)

onTimeChanged

public void onTimeChanged()

Specified by:

onTimeChanged in interface TimeChangeListener

onGrantPropertiesChange

public void onGrantPropertiesChange(BrandSetService service)

Description copied from interface: GrantPropertiesListener

Called when BrandSetService is provided with new grant properties, which can be accessed by getGrantProperties() .

Specified by:

onGrantPropertiesChange in interface GrantPropertiesListener

Parameters:

service - the BrandSetService

getWaterType

public RecipeWaterType getWaterType(Pourable pourable)

Return the water type of the specified pourable.

Parameters:

pourable - the FreestylePourable to check

hidePlainWaterBeverage

public void hidePlainWaterBeverage(boolean hide)

Hide plain water as a beverage. When hidden, the plain water beverage will not be visible. When not hidden, plain water will be visible based on standard visibility logic.

hideCarbWaterBeverage

public void hideCarbWaterBeverage(boolean hide)

Hide carb water as a beverage. When hidden, the carb water beverage will not be visible. When not hidden, carb water will be visible based on standard visibility logic.