Package noiseOneBand

Class OneBandControl

java.lang.Object

PamController.PamControlledUnit

noiseOneBand.OneBandControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class OneBandControl
extends PamControlledUnit
implements PamSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NMEASURES	The number of measures taken by OneBandControl.
protected OneBandParameters	oneBandParameters

Fields inherited from class PamController.PamControlledUnit

isMixed, isViewer

Constructor Summary

Constructors

Constructor	Description
OneBandControl(String unitName)

Method Summary

Modifier and Type	Method	Description
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
static String	getMeasurementName(int index)	Gets the measurement name for a given index (0 invalid input: '<'= index invalid input: '<' NMEASURES).
String	getModuleSummary()	Get a module summary text string for shorthand output to anyting wanting a short summary of data state / numbers of detections.
OneBandProcess	getOneBandProcess()
OneBandParameters	getParameters()
OneBandPulseProcess	getPulseProcess()
Serializable	getSettingsReference()
long	getSettingsVersion()
Object	getShortUnitType()
PamTabPanel	getTabPanel()	Gets a reference to a panel to be added to a view
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	settingsMenuAction(Frame parentFrame)

Methods inherited from class PamController.PamControlledUnit

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Field Details

NMEASURES

public static final int NMEASURES

The number of measures taken by OneBandControl. See getMeasurementName(int) for description and units of each measure.

See Also:

• Constant Field Values

oneBandParameters

protected OneBandParameters oneBandParameters

Constructor Details

OneBandControl

public OneBandControl(String unitName)

Method Details

getOneBandProcess

public OneBandProcess getOneBandProcess()

Returns:

the dbHtProcess

getParameters

public OneBandParameters getParameters()

Returns:

the dbHtParameters

getTabPanel

public PamTabPanel getTabPanel()

Description copied from class: PamControlledUnit

Gets a reference to a panel to be added to a view

Overrides:

getTabPanel in class PamControlledUnit

Returns:

reference to a PamTabPanel object

See Also:

• PamTabPanel
• PamSidePanel

getMeasurementName

public static String getMeasurementName(int index)

Gets the measurement name for a given index (0 invalid input: '<'= index invalid input: '<' NMEASURES). This requires access to the Global Medium Manager to report on the correct units.

Parameters:

index - The index of the measure.

Returns:

The text representation of the relevant measure, including units.

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.

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.

settingsMenuAction

public void settingsMenuAction(Frame parentFrame)

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

Parameters:

pamControlledUnitSettings -

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

getModuleSummary

public String getModuleSummary()

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.
You should not override this version of the function, but instead override getModuleSummary(boolean clear) which allows for optional clearing of summary data.

Overrides:

getModuleSummary in class PamControlledUnit

Returns:

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

getShortUnitType

public Object getShortUnitType()

Overrides:

getShortUnitType in class PamControlledUnit

Returns:

a shortened version of the unit type for use in module summary strings.

getPulseProcess

public OneBandPulseProcess getPulseProcess()

Returns:

the dbhtPulseProcess

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