difar

Class DifarControl

java.lang.Object

PamController.PamControlledUnit

difar.DifarControl

All Implemented Interfaces:

PamSettings

public class DifarControl
extends PamControlledUnit
implements PamSettings

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	SPLITDISPLAYS

Constructor Summary

Constructors

Constructor and Description
DifarControl(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDemux() Can the system handle demuxing the next data unit ? Currently used to enable menus on the clip display
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
javax.swing.JMenuItem	createDisplayMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with the view
void	deployBuoy(int channel) Deploy a DIFAR buoy.
boolean	displayMenu(java.awt.Frame parentFrame)
CalibrationHistogram	getCalCorrectionHistogram(int channel)
CalibrationHistogram	getCalibrationHistogram(int channel)
ClipDisplayParameters	getClipDisplayParams(DifarDataUnit difarDataUnit)
DifarDataUnit	getCurrentDemuxedUnit()
java.lang.String	getCurrentlySelectedGroup()
DemuxProgressDisplay	getDemuxProgressDisplay()
DifarDisplayContainer	getDifarDisplayContainer()
DifarDisplayContainer2	getDifarDisplayContainer2()
DIFARGram	getDifarGram()
DifarParameters	getDifarParameters()
DifarProcess	getDifarProcess()
DIFARQueuePanel	getDifarQueue()
DIFARUnitControlPanel	getDifarUnitControlPanel()
int	getDisplayFFTHop(DifarDataUnit difarDataUnit)
int	getDisplayFFTLength(DifarDataUnit difarDataUnit) Get the display FFT length, which may depend on the type of data unit.
DifarActionsVesselPanel	getInternalActionsPanel()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamSymbol	getSpeciesSymbol(DifarDataUnit difarDataUnit) Get the appropriate symbol for the selected species (or none).
TrackedGroupProcess	getTrackedGroupProcess()
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
double	rangeForDataType(DifarDataUnit difarDataUnit) Get a display range for a particular data unit, as will be used by the map.
boolean	removeUnit() Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
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(java.lang.String groupName)
boolean	settingMenu(java.awt.Frame parentFrame)
TrackedGroupProcess	setTrackedGroupProcess(TrackedGroupProcess trackedGroupProcess)
void	showCalibrationDialog(int channel) Shows the calibration dialog for a particular channel.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Field Detail

SPLITDISPLAYS

public static final boolean SPLITDISPLAYS

See Also:

Constant Field Values

Constructor Detail

DifarControl

public DifarControl(java.lang.String unitName)

Method Detail

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

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

createDisplayMenu

public javax.swing.JMenuItem createDisplayMenu(java.awt.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 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.

settingMenu

public boolean settingMenu(java.awt.Frame parentFrame)

displayMenu

public boolean displayMenu(java.awt.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

rangeForDataType

public double rangeForDataType(DifarDataUnit difarDataUnit)

Get a display range for a particular data unit, as will be used by the map. Currently there is only one value which is fixed in the parameters.

Parameters:

difarDataUnit -

Returns:

a range in metres.

getDisplayFFTLength

public int getDisplayFFTLength(DifarDataUnit difarDataUnit)

Get the display FFT length, which may depend on the type of data unit.

Returns:

FFT length for data display.

getDisplayFFTHop

public int getDisplayFFTHop(DifarDataUnit difarDataUnit)

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 java.lang.String getCurrentlySelectedGroup()

setCurrentlySelectedGroup

public void setCurrentlySelectedGroup(java.lang.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.

getCalibrationHistogram

public CalibrationHistogram getCalibrationHistogram(int channel)

getCalCorrectionHistogram

public CalibrationHistogram getCalCorrectionHistogram(int channel)

showCalibrationDialog

public void showCalibrationDialog(int channel)

Shows the calibration dialog for a particular channel.

Parameters:

channel -

deployBuoy

public void deployBuoy(int channel)

Deploy a DIFAR buoy. In reality this means show only the streamer dialog for a single channel.

Parameters:

channel - channel number. If < 0 or if the streamer can't be found, then show the full array dialog

getTrackedGroupProcess

public TrackedGroupProcess getTrackedGroupProcess()

setTrackedGroupProcess

public TrackedGroupProcess setTrackedGroupProcess(TrackedGroupProcess trackedGroupProcess)