Package com.tccc.kos.ext.freestyle.hardware.can.subnode.ice

Class IceAgitator

java.lang.Object
com.tccc.kos.ext.freestyle.hardware.can.subnode.ice.IceAgitator
All Implemented Interfaces:
com.tccc.kos.commons.core.service.config.ConfigAware<IceAgitatorConfig>, com.tccc.kos.commons.core.service.handle.HandleAware, com.tccc.kos.commons.core.service.state.StateAware<IceAgitatorState>
public class IceAgitator extends Object implements com.tccc.kos.commons.core.service.config.ConfigAware<IceAgitatorConfig>, com.tccc.kos.commons.core.service.state.StateAware<IceAgitatorState>
Agitator for ice.
Version:
Aug-5-17

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    agitate(int duration, boolean iceGate)
    Perform a custom agitation cycle.
    IceAgitatorConfig
    getConfig()
     
    com.tccc.kos.commons.core.service.handle.Handle
    getHandle()
     
    IceAgitatorState
    getState()
     
    void
    onConfigChanged(com.tccc.kos.commons.core.service.config.BeanChanges changes)
     
    void
    setConfig(IceAgitatorConfig config)
     
    void
    startIce()
    Dispense ice for the max allowable amount of time.
    void
    startIce(boolean force)
    Dispense ice for the max allowable amount of time.
    void
    startIce(int duration, boolean force)
    Dispense ice for the specified amount of time in seconds.
    void
    stopIce()
    Stop any ice dispense that is in progress.
    void
    testAgitation()
    Perform an ice agitator test.
    void
    testIceGate()
    Perform an ice gate test.

    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

  • Method Details

    • startIce

      public void startIce()
      Dispense ice for the max allowable amount of time.

    • startIce

      public void startIce(boolean force)
      Dispense ice for the max allowable amount of time.
      Parameters:
      force - if true, dispense even if paused

    • startIce

      public void startIce(int duration, boolean force)
      Dispense ice for the specified amount of time in seconds.
      Parameters:
      duration - the time in ms
      force - if true, start ice even if paused

    • stopIce

      public void stopIce()
      Stop any ice dispense that is in progress.

    • agitate

      public void agitate(int duration, boolean iceGate)
      Perform a custom agitation cycle.
      Parameters:
      duration - duration in seconds
      iceGate - true if the ice gate should be open

    • testIceGate

      public void testIceGate()
      Perform an ice gate test.

    • testAgitation

      public void testAgitation()
      Perform an ice agitator test.

    • onConfigChanged

      public void onConfigChanged(com.tccc.kos.commons.core.service.config.BeanChanges changes)
      Specified by:
      onConfigChanged in interface com.tccc.kos.commons.core.service.config.ConfigAware<IceAgitatorConfig>

    • getConfig

      public IceAgitatorConfig getConfig()
      Specified by:
      getConfig in interface com.tccc.kos.commons.core.service.config.ConfigAware<IceAgitatorConfig>

    • setConfig

      public void setConfig(IceAgitatorConfig config)
      Specified by:
      setConfig in interface com.tccc.kos.commons.core.service.config.ConfigAware<IceAgitatorConfig>

    • getState

      public IceAgitatorState getState()
      Specified by:
      getState in interface com.tccc.kos.commons.core.service.state.StateAware<IceAgitatorState>

    • getHandle

      public com.tccc.kos.commons.core.service.handle.Handle getHandle()
      Specified by:
      getHandle in interface com.tccc.kos.commons.core.service.handle.HandleAware