whistleDetector
Class WhistleControl

java.lang.Object
  PamController.PamControlledUnit
      whistleDetector.WhistleControl

All Implemented Interfaces:

PamSettings

public class WhistleControl
extends PamControlledUnit
implements PamSettings

Author:

Doug Gillespie

Implementation of PamControlledUnit for controlling the whistle detector

This currently does not have a display since whistle information can be easily displayed on the standard spectrogram displays. It does provide a mnu though (which doesn't do anything yet)

Nested Class Summary

(package private) class

WhistleControl.menuDetection

Field Summary

protected WhistleEventDetector	eventDetector
protected java.util.ArrayList<PeakDetectorProvider>	peakDetectorProviders
protected WhistleControl	THIS
protected WhistleDetector	whistleDetector
protected WhistleLocaliser	whistleLocaliser
protected WhistleParameters	whistleParameters
protected WhistleSidePanel	whistleSidePanel

Fields inherited from class PamController.PamControlledUnit

isViewer

Constructor Summary

WhistleControl(java.lang.String name)

Method Summary

javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
WhistleParameters	getWhistleParameters()
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, canClose, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, fillXMLParameters, getFrameNumber, getNumPamProcesses, getPamController, getPamModuleInfo, getPamProcess, getPamView, getSidePanel, 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

whistleDetector

protected WhistleDetector whistleDetector

THIS

protected WhistleControl THIS

eventDetector

protected WhistleEventDetector eventDetector

whistleSidePanel

protected WhistleSidePanel whistleSidePanel

whistleLocaliser

protected WhistleLocaliser whistleLocaliser

whistleParameters

protected WhistleParameters whistleParameters

peakDetectorProviders

protected java.util.ArrayList<PeakDetectorProvider> peakDetectorProviders

Constructor Detail

WhistleControl

public WhistleControl(java.lang.String name)

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.

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

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

getWhistleParameters

public WhistleParameters getWhistleParameters()