Package adams.flow.standalone.rats.output

Class Serialize

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable
    public class Serialize
extends AbstractRatOutput
    Saves the objects that it receives using serialization under the filename created by the filename generator. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -filename-generator <adams.core.io.AbstractFilenameGenerator> (property: filenameGenerator)
    The filename generator to use.
    default: adams.core.io.SimpleFilenameGenerator
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_FilenameGenerator

        protected adams.core.io.AbstractFilenameGenerator m_FilenameGenerator
        the filename generator to use.

    • Constructor Detail

      • Serialize

        public Serialize()

    • 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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractRatOutput
        Returns:
        null if no info available, otherwise short string

      • setFilenameGenerator

        public void setFilenameGenerator​(adams.core.io.AbstractFilenameGenerator value)
        Sets the filename generator.
        Parameters:
        value - the generator

      • getFilenameGenerator

        public adams.core.io.AbstractFilenameGenerator getFilenameGenerator()
        Returns the filename generator.
        Returns:
        the generator

      • filenameGeneratorTipText

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

      • doTransmit

        protected String doTransmit()
        Performs the actual transmission.
        Specified by:
        doTransmit in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message