listening
Class ListeningControl

java.lang.Object
  PamController.PamControlledUnit
      listening.ListeningControl

All Implemented Interfaces:

PamSettings

public class ListeningControl
extends PamControlledUnit
implements PamSettings

Nested Class Summary

private class

ListeningControl.AuralSettings

Field Summary

static int	COMMENT_LENGTH
protected ListeningParameters	listeningParameters
protected ListeningProcess	listeningProcess
static int	SPECIES_LENGTH
protected ThingHeardTabPanelControl	tabPanelControl

Fields inherited from class PamController.PamControlledUnit

isViewer

Constructor Summary

ListeningControl(java.lang.String unitName)

Method Summary

private void	auralSettings(java.awt.Frame frame)
protected void	buttonPress(int speciesIndex, int volume, int hydrophones, java.lang.String comment)
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
protected void	effortButton(int index, int hydrophones)
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
protected PamSymbol	getSpeciesSymbol(java.lang.String strSpecies) Try to find the correct symbol for a species this gets used when data are read back from the database.
private void	newSettings()
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

listeningProcess

protected ListeningProcess listeningProcess

tabPanelControl

protected ThingHeardTabPanelControl tabPanelControl

listeningParameters

protected ListeningParameters listeningParameters

COMMENT_LENGTH

public static int COMMENT_LENGTH

SPECIES_LENGTH

public static int SPECIES_LENGTH

Constructor Detail

ListeningControl

public ListeningControl(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.

auralSettings

private void auralSettings(java.awt.Frame frame)

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

newSettings

private void newSettings()

getSpeciesSymbol

protected PamSymbol getSpeciesSymbol(java.lang.String strSpecies)

Try to find the correct symbol for a species this gets used when data are read back from the database.

Parameters:

strSpecies - species string

Returns:

symbol or null

effortButton

protected void effortButton(int index,
                            int hydrophones)

buttonPress

protected void buttonPress(int speciesIndex,
                           int volume,
                           int hydrophones,
                           java.lang.String comment)

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