Package adams.gui.visualization.instance

Class SimpleInstancePanelUpdater

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.core.DataPlotUpdater<InstancePanel,​InstanceContainer>, Serializable
    public class SimpleInstancePanelUpdater
extends AbstractInstancePanelUpdater
    Updates the flow after the specified number of tokens have been processed.

    Valid options are: 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -update-interval <int> (property: updateInterval)
    Specifies the number of tokens after which the display is being updated 
    (markers excluded); <= 0 means no update until flow finished.
    default: 1
    minimum: -1
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_NumTokensAccepted
      the number of tokens accepted.
      protected int m_UpdateInterval
      the interval of tokens processed after which to update the display.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canNotify​(InstancePanel panel, InstanceContainer cont)
      Checks whether all conditions are met to notify the listeners for changes in the plot.
      void defineOptions()
      Adds options to the internal list of options.
      int getUpdateInterval()
      Returns the number of tokens after which the display is being updated.
      String globalInfo()
      Returns a string describing the object.
      protected void reset()
      Resets the object.
      void setUpdateInterval​(int value)
      Sets the number of tokens after which the display is being updated.
      String updateIntervalTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.core.AbstractDataPlotUpdater

        doUpdate, update, update

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_UpdateInterval

        protected int m_UpdateInterval
        the interval of tokens processed after which to update the display.

      • m_NumTokensAccepted

        protected int m_NumTokensAccepted
        the number of tokens accepted.

    • Constructor Detail

      • SimpleInstancePanelUpdater

        public SimpleInstancePanelUpdater()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • reset

        protected void reset()
        Resets the object.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setUpdateInterval

        public void setUpdateInterval​(int value)
        Sets the number of tokens after which the display is being updated.
        Parameters:
        value - the number of tokens

      • getUpdateInterval

        public int getUpdateInterval()
        Returns the number of tokens after which the display is being updated.
        Returns:
        the number of tokens

      • updateIntervalTipText

        public String updateIntervalTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • canNotify

        protected boolean canNotify​(InstancePanel panel,
                            InstanceContainer cont)
        Checks whether all conditions are met to notify the listeners for changes in the plot.
        Specified by:
        canNotify in class adams.flow.core.AbstractDataPlotUpdater<InstancePanel,​InstanceContainer>
        Parameters:
        panel - the plotter to potentially update
        cont - the current plot container
        Returns:
        true if the listeners can be notified