depthReadout

Class DepthControl

java.lang.Object

PamController.PamControlledUnit

depthReadout.DepthControl

All Implemented Interfaces:

PamSettings

public class DepthControl
extends PamControlledUnit
implements PamSettings

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
DepthDataBlock	getDepthDataBlock()
DepthSystem	getDepthSystem()
java.lang.String	getDepthSystemName(int iSystem)
int	getNumDepthSystems()
int	getSensorForHydrophone(int iPhone) Return the sensor number for a particular hydrophone or -1 if this hydrophone is not associated with a sensor.
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamSidePanel	getSidePanel() Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	removeUnit() Called to remove a unit.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, 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

Constructor Detail

DepthControl

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

getSensorForHydrophone

public int getSensorForHydrophone(int iPhone)

Return the sensor number for a particular hydrophone or -1 if this hydrophone is not associated with a sensor.

Parameters:

iPhone -

Returns:

sensor number for a given hydrophone

getDepthDataBlock

public DepthDataBlock getDepthDataBlock()

getNumDepthSystems

public int getNumDepthSystems()

getDepthSystemName

public java.lang.String getDepthSystemName(int iSystem)

getDepthSystem

public DepthSystem getDepthSystem()

getSidePanel

public PamSidePanel getSidePanel()

Description copied from class: PamControlledUnit

Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

Overrides:

getSidePanel in class PamControlledUnit

Returns:

a pamSidePanel object.

See Also:

PamSidePanel, PamTabPanel

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.

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

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