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.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderFile m_Output
      the output file.
      • 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 Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected abstract adams.core.io.PlaceholderFile getDefaultOutput()
      Returns the default output file to use.
      adams.core.io.PlaceholderFile getOutput()
      Returns the output file.
      String outputTipText()
      Returns the tip text for this property.
      void setOutput​(adams.core.io.PlaceholderFile 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

        getLoggingLevel
    • Field Detail

      • m_Output

        protected adams.core.io.PlaceholderFile 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
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler
      • getDefaultOutput

        protected abstract adams.core.io.PlaceholderFile getDefaultOutput()
        Returns the default output file to use.
        Returns:
        the default
      • setOutput

        public void setOutput​(adams.core.io.PlaceholderFile value)
        Sets the output file to use.
        Parameters:
        value - the output file
      • getOutput

        public adams.core.io.PlaceholderFile getOutput()
        Returns the output file.
        Returns:
        the output file
      • outputTipText

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