Package adams.gui.scripting

Class WriteSpectrum

  • All Implemented Interfaces:
    adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.gui.core.UndoHandler, Serializable, Comparable
    public class WriteSpectrum
extends AbstractSpectrumPanelScriptlet
    Action parameters:
       write-spectrum <1-based index> <filename> [writer command-line]


    Description: 
       Saves the spectrum at the specified position to the file.


    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ACTION
      the action to execute.

      • Fields inherited from class adams.gui.scripting.AbstractScriptlet

        m_DataProvider, m_Owner, m_Parameters, m_Stopped

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      WriteSpectrum()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String doProcess​(String options)
      Processes the options.
      String getAction()
      Returns the action string used in the command processor.
      String getDescription()
      Returns the full description of the action.
      protected String getOptionsDescription()
      Returns a one-line listing of the options of the action.

      • Methods inherited from class adams.gui.scripting.AbstractUndoScriptlet

        addUndoPoint, getUndo, isUndoSupported, setUndo

      • Methods inherited from class adams.gui.scripting.AbstractScriptlet

        compareTo, equals, forName, getBasePanel, getDataProvider, getOwner, getParameter, getParameterDescription, getScriptlets, hashCode, hasOwner, hasParameter, initialize, isStopped, process, setDataProvider, setOwner, setParameter, showStatus, stopExecution, toString

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

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

    • Constructor Detail

      • WriteSpectrum

        public WriteSpectrum()

    • Method Detail

      • getAction

        public String getAction()
        Returns the action string used in the command processor.
        Specified by:
        getAction in class adams.gui.scripting.AbstractScriptlet
        Returns:
        the action string

      • getOptionsDescription

        protected String getOptionsDescription()
        Returns a one-line listing of the options of the action.
        Overrides:
        getOptionsDescription in class adams.gui.scripting.AbstractScriptlet
        Returns:
        the options or null if none

      • getDescription

        public String getDescription()
        Returns the full description of the action.
        Specified by:
        getDescription in class adams.gui.scripting.AbstractScriptlet
        Returns:
        the full description

      • doProcess

        protected String doProcess​(String options)
                    throws Exception
        Processes the options.
        Specified by:
        doProcess in class adams.gui.scripting.AbstractScriptlet
        Parameters:
        options - additional/optional options for the action
        Returns:
        null if no error, otherwise error message
        Throws:
        Exception - if something goes wrong