Package RightWhaleEdgeDetector

Class RWEControl

java.lang.Object

PamController.PamControlledUnit

RightWhaleEdgeDetector.RWEControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class RWEControl
extends PamControlledUnit
implements PamSettings

Exact implementation of the 2003 Right Whale detector I developed when I was working for IFAW and is now implemented in the Cornell right whale buoys. This is not by any means the best right whale detector around any more but has been implemented purely for backward compatible analysis of old data and and ease of comparing with newer detectors as they are developed.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
RWEControl(String unitName)

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
GroupedSourceParameters	getGroupSourceParameters()
String	getModuleSummary(boolean clear)	Get a module summary text string for shorthand output to anyting wanting a short summary of data state / numbers of detections.
RWEParameters	getRweParameters()
RWEProcess	getRweProcess()
Serializable	getSettingsReference()
long	getSettingsVersion()
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	settingsDialog(Frame frame)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Constructor Details

RWEControl

public RWEControl(String unitName)

Method Details

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 JMenuItem createDetectionMenu(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

public void settingsDialog(Frame frame)

getSettingsReference

public 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

getGroupSourceParameters

public GroupedSourceParameters getGroupSourceParameters()

getRweProcess

public RWEProcess getRweProcess()

Returns:

the rweProcess

getRweParameters

public RWEParameters getRweParameters()

getModuleSummary

public String getModuleSummary(boolean clear)

Description copied from class: PamControlledUnit

Get a module summary text string for shorthand output to anyting wanting a short summary of data state / numbers of detections.

Overrides:

getModuleSummary in class PamControlledUnit

Parameters:

clear - clear data after generating string, so that counts of detections, etc. start again from 0.

Returns:

module summary string - goings on since the last call to this function