Package likelihoodDetectionModule

Class LikelihoodDetectionUnit

java.lang.Object

PamController.PamControlledUnit

likelihoodDetectionModule.LikelihoodDetectionUnit

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class LikelihoodDetectionUnit
extends PamControlledUnit
implements PamSettings

The class LikelihoodDetectionUnit implements that standard PamControlledUnit functionality required by PamGuard for a plug-in module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LikelihoodDetectionUnit.ProcessGroup	The ProcessGroup objects is used by the controlling unit to keep track of one or more set of detection processes for a target configuration.

Constructor Summary

Constructors

Constructor	Description
LikelihoodDetectionUnit(String name)	Instantiates a new likelihood detection unit.

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
LikelihoodDetectionParameters	getParameters()	Returns the configured LikelihoodDetectionParameters for the module.
Serializable	getSettingsReference()
long	getSettingsVersion()
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings settings)

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, 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

LikelihoodDetectionUnit

public LikelihoodDetectionUnit(String name)

Instantiates a new likelihood detection unit.

Parameters:

name - The assigned name of the detection module.

Method Details

getParameters

public LikelihoodDetectionParameters getParameters()

Returns the configured LikelihoodDetectionParameters for the module.

Returns:

the parameters

See Also:

• LikelihoodDetectionParameters

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 settings)

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

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.

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