whistlesAndMoans
Class WhistleMoanControl

java.lang.Object
  PamController.PamControlledUnit
      whistlesAndMoans.WhistleMoanControl

All Implemented Interfaces:

PamSettings

public class WhistleMoanControl
extends PamControlledUnit
implements PamSettings

Nested Class Summary

(package private) class

WhistleMoanControl.DetectionSettings

Field Summary

private SpectrogramNoiseProcess	spectrogramNoiseProcess
protected WhistleToneParameters	whistleToneParameters
private WhistleToneConnectProcess	whistleToneProcess

Fields inherited from class PamController.PamControlledUnit

isViewer

Constructor Summary

WhistleMoanControl(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.
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamSidePanel	getSidePanel() Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
SpectrogramNoiseProcess	getSpectrogramNoiseProcess()
WhistleToneConnectProcess	getWhistleToneProcess()
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
private void	settingsDialog(java.awt.Frame parentFrame)

Methods inherited from class PamController.PamControlledUnit

addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, canClose, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, getFrameNumber, getNumPamProcesses, getPamController, getPamModuleInfo, getPamProcess, getPamView, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getUnitName, getUnitType, gotoTab, notifyArrayChanged, pamHasStopped, pamToStart, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, 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

whistleToneProcess

private WhistleToneConnectProcess whistleToneProcess

whistleToneParameters

protected WhistleToneParameters whistleToneParameters

spectrogramNoiseProcess

private SpectrogramNoiseProcess spectrogramNoiseProcess

Constructor Detail

WhistleMoanControl

public WhistleMoanControl(java.lang.String unitName)

Method Detail

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

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.

settingsDialog

private void settingsDialog(java.awt.Frame parentFrame)

getSidePanel

public PamSidePanel getSidePanel()

Description copied from class: PamControlledUnit

Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

Overrides:

getSidePanel in class PamControlledUnit

Returns:

a pamSidePanel object.

See Also:

PamSidePanel, PamTabPanel

getSpectrogramNoiseProcess

public SpectrogramNoiseProcess getSpectrogramNoiseProcess()

Returns:

the spectrogramNoiseProcess

getWhistleToneProcess

public WhistleToneConnectProcess getWhistleToneProcess()

Returns:

the whistleToneProcess

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

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: