Class AbstractFileBaseRecorder

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    AbstractSoundRecorder, AbstractVideoRecorder

    public abstract class AbstractFileBaseRecorder
    extends AbstractRecorder
    Ancestor for file-based recorders.
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Modifier and Type Field Description
      protected m_Output
      the output file.
      • Fields inherited from class adams.core.option.AbstractOptionHandler

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected abstract getDefaultOutput()
      Returns the default output file to use. getOutput()
      Returns the output file.
      String outputTipText()
      Returns the tip text for this property.
      void setOutput​( value)
      Sets the output file to use.
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

    • Field Detail

      • m_Output

        protected m_Output
        the output file.
    • Constructor Detail

      • AbstractFileBaseRecorder

        public AbstractFileBaseRecorder()
    • Method Detail

      • defineOptions

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

        protected abstract getDefaultOutput()
        Returns the default output file to use.
        the default
      • setOutput

        public void setOutput​( value)
        Sets the output file to use.
        value - the output file
      • getOutput

        public getOutput()
        Returns the output file.
        the output file
      • outputTipText

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