fftManager
Class PamFFTControl

java.lang.Object
  extended by PamController.PamControlledUnit
      extended by fftManager.PamFFTControl
All Implemented Interfaces:
PamSettings

public class PamFFTControl
extends PamControlledUnit
implements PamSettings


Nested Class Summary
(package private)  class PamFFTControl.FFTSettings
           
 
Field Summary
protected  FFTParameters fftParameters
           
private  FFTPluginPanelProvider fFTPluginPanelProvider
           
protected  PamFFTProcess fftProcess
           
private  SpectrogramNoiseProcess spectrogramNoiseProcess
           
 
Fields inherited from class PamController.PamControlledUnit
isViewer
 
Constructor Summary
PamFFTControl(java.lang.String unitName)
           
 
Method Summary
 javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame)
          Create a JMenu object containing MenuItems associated with PamProcesses
protected  boolean fillXMLParameters(org.w3c.dom.Document doc, org.w3c.dom.Element paramsEl)
          Add Module specific XML data.
 FFTParameters getFftParameters()
           
 java.io.Serializable getSettingsReference()
           
 long getSettingsVersion()
           
 void rename(java.lang.String newName)
           
 boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
           
 void setupControlledUnit()
          called for all PamControlledUnits after all units have been created.
private  void showParamsDialog(java.awt.Frame parentFrame)
           
 
Methods inherited from class PamController.PamControlledUnit
addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, canClose, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, getFrameNumber, getNumPamProcesses, getPamController, getPamModuleInfo, getPamProcess, getPamView, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getUnitName, getUnitType, gotoTab, notifyArrayChanged, notifyModelChanged, pamHasStopped, pamToStart, removePamProcess, removeUnit, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface PamController.PamSettings
getUnitName, getUnitType
 

Field Detail

fftProcess

protected PamFFTProcess fftProcess

fftParameters

protected FFTParameters fftParameters

fFTPluginPanelProvider

private FFTPluginPanelProvider fFTPluginPanelProvider

spectrogramNoiseProcess

private SpectrogramNoiseProcess spectrogramNoiseProcess
Constructor Detail

PamFFTControl

public PamFFTControl(java.lang.String unitName)
Method Detail

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame)
Description copied from class: PamControlledUnit
Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:
createDetectionMenu in class PamControlledUnit
Parameters:
parentFrame - The owner frame of the menu
Returns:
reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.


showParamsDialog

private void showParamsDialog(java.awt.Frame parentFrame)

getFftParameters

public FFTParameters getFftParameters()

getSettingsReference

public java.io.Serializable getSettingsReference()
Specified by:
getSettingsReference in interface PamSettings
Returns:
The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()
Specified by:
getSettingsVersion in interface PamSettings
Returns:
An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
Specified by:
restoreSettings in interface PamSettings
Returns:
true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

setupControlledUnit

public void setupControlledUnit()
Description copied from class: PamControlledUnit
called for all PamControlledUnits after all units have been created. This is a good time for the controlled units and processes to find and check their source data and the configuration generally since most onjects (i.e. output data blocks) should be in place

Overrides:
setupControlledUnit in class PamControlledUnit

rename

public void rename(java.lang.String newName)
Overrides:
rename in class PamControlledUnit

fillXMLParameters

protected boolean fillXMLParameters(org.w3c.dom.Document doc,
                                    org.w3c.dom.Element paramsEl)
Description copied from class: PamControlledUnit
Add Module specific XML data.

this will generally be the place where most modules set their xml settings data.

Overrides:
fillXMLParameters in class PamControlledUnit
Returns: