Package difar

Class DifarControl

java.lang.Object

PamController.PamControlledUnit

difar.DifarControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class DifarControl
extends PamControlledUnit
implements PamSettings

Field Summary

Fields

Modifier and Type	Field	Description
SonobuoyManager	sonobuoyManager
static final boolean	SPLITDISPLAYS

Constructor Summary

Constructors

Constructor	Description
DifarControl(String unitName)

Method Summary

Modifier and Type	Method	Description
boolean	canDemux()	Can the system handle demuxing the next data unit ? Currently used to enable menus on the clip display
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
JMenuItem	createDisplayMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with the view
boolean	displayMenu(Frame parentFrame)
ClipDisplayParameters	getClipDisplayParams(DifarDataUnit difarDataUnit)
DifarDataUnit	getCurrentDemuxedUnit()
String	getCurrentlySelectedGroup()
LookupItem	getCurrentlySelectedSpecies()	Allow the user to select the default classification for clips generated by manually marking the spectrogram
JList	getDefaultClassificationSelector()
DemuxProgressDisplay	getDemuxProgressDisplay()
DifarDisplayContainer	getDifarDisplayContainer()
DifarDisplayContainer2	getDifarDisplayContainer2()
DIFARGram	getDifarGram()
DifarParameters	getDifarParameters()
DifarProcess	getDifarProcess()
DIFARQueuePanel	getDifarQueue()
DIFARUnitControlPanel	getDifarUnitControlPanel()
DifarActionsVesselPanel	getInternalActionsPanel()
Serializable	getSettingsReference()
long	getSettingsVersion()
SonobuoyManagerContainer	getSonobuoyManagerContainer()
PamSymbol	getSpeciesSymbol(DifarDataUnit difarDataUnit)	Get the appropriate symbol for the selected species (or none).
TrackedGroupProcess	getTrackedGroupProcess()
boolean	isDeleteEnabled()
boolean	isSaveEnabled()
boolean	isSaveWithoutCrossEnabled()
boolean	isTrackedGroupSelectable(String groupName)
DifarParameters	loadClassificationParams(Frame frame, DifarParameters difarParameters)
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
boolean	removeUnit()	Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
boolean	saveClassificationParams(Window frame, LookupList speciesList, ArrayList<DifarParameters.SpeciesParams> speciesParams)	Save a set of classifier params.
void	sendDifarMessage(DIFARMessage message)	Called from just about anywhere in the DIFAR system, this will process various difar messages and then pass the notification on to all the difar displays.
void	setCurrentlySelectedGroup(String groupName)
boolean	settingMenu(Frame parentFrame)
TrackedGroupProcess	setTrackedGroupProcess(TrackedGroupProcess trackedGroupProcess)
void	updateSidePanel()

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, 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, 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

Field Details

SPLITDISPLAYS

public static final boolean SPLITDISPLAYS

See Also:

• Constant Field Values

sonobuoyManager

public SonobuoyManager sonobuoyManager

Constructor Details

DifarControl

public DifarControl(String unitName)

Method Details

removeUnit

public boolean removeUnit()

Description copied from class: PamControlledUnit

Called to remove a unit.

Overrides:

removeUnit in class PamControlledUnit

Returns:

try (not used)

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

sendDifarMessage

public void sendDifarMessage(DIFARMessage message)

Called from just about anywhere in the DIFAR system, this will process various difar messages and then pass the notification on to all the difar displays.

Parameters:

message - DIFAR message

getDifarDisplayContainer

public DifarDisplayContainer getDifarDisplayContainer()

getDifarDisplayContainer2

public DifarDisplayContainer2 getDifarDisplayContainer2()

getSonobuoyManagerContainer

public SonobuoyManagerContainer getSonobuoyManagerContainer()

createDisplayMenu

public JMenuItem createDisplayMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with the view

Overrides:

createDisplayMenu in class PamControlledUnit

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.

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.

settingMenu

public boolean settingMenu(Frame parentFrame)

displayMenu

public boolean displayMenu(Frame parentFrame)

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

getDifarGram

public DIFARGram getDifarGram()

getDifarParameters

public DifarParameters getDifarParameters()

getDifarProcess

public DifarProcess getDifarProcess()

getInternalActionsPanel

public DifarActionsVesselPanel getInternalActionsPanel()

getDifarQueue

public DIFARQueuePanel getDifarQueue()

getDemuxProgressDisplay

public DemuxProgressDisplay getDemuxProgressDisplay()

Returns:

the demuxProgressDisplay

getClipDisplayParams

public ClipDisplayParameters getClipDisplayParams(DifarDataUnit difarDataUnit)

canDemux

public boolean canDemux()

Can the system handle demuxing the next data unit ? Currently used to enable menus on the clip display

Returns:

true if it's OK to demux the next sound.

getDifarUnitControlPanel

public DIFARUnitControlPanel getDifarUnitControlPanel()

Returns:

the difarUnitControlPanel

getCurrentDemuxedUnit

public DifarDataUnit getCurrentDemuxedUnit()

Returns:

the currentDemuxedUnit

getCurrentlySelectedGroup

public String getCurrentlySelectedGroup()

setCurrentlySelectedGroup

public void setCurrentlySelectedGroup(String groupName)

isTrackedGroupSelectable

public boolean isTrackedGroupSelectable(String groupName)

getSpeciesSymbol

public PamSymbol getSpeciesSymbol(DifarDataUnit difarDataUnit)

Get the appropriate symbol for the selected species (or none).

Parameters:

difarDataUnit - DIFAR data unit

Returns:

symbol or null if no species assigned.

getTrackedGroupProcess

public TrackedGroupProcess getTrackedGroupProcess()

setTrackedGroupProcess

public TrackedGroupProcess setTrackedGroupProcess(TrackedGroupProcess trackedGroupProcess)

saveClassificationParams

public boolean saveClassificationParams(Window frame,
 LookupList speciesList,
 ArrayList<DifarParameters.SpeciesParams> speciesParams)

Save a set of classifier params. Since this is primarily an export function, it will always show the file save dialog

Parameters:

speciesParams - parameters to save

Returns:

true if successful.

loadClassificationParams

public DifarParameters loadClassificationParams(Frame frame,
 DifarParameters difarParameters)

getCurrentlySelectedSpecies

public LookupItem getCurrentlySelectedSpecies()

Allow the user to select the default classification for clips generated by manually marking the spectrogram

Returns:

- The species (DIFAR classification) selected by the user

getDefaultClassificationSelector

public JList getDefaultClassificationSelector()

updateSidePanel

public void updateSidePanel()

isSaveEnabled

public boolean isSaveEnabled()

isSaveWithoutCrossEnabled

public boolean isSaveWithoutCrossEnabled()

isDeleteEnabled

public boolean isDeleteEnabled()