Package beamformer.continuous

Class BeamFormerControl

java.lang.Object

PamController.PamControlledUnit

beamformer.BeamFormerBaseControl

beamformer.continuous.BeamFormerControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class BeamFormerControl
extends BeamFormerBaseControl
implements PamSettings

Field Summary

Fields

Modifier and Type	Field	Description
static String	unitType

Constructor Summary

Constructors

Constructor	Description
BeamFormerControl(String unitName)	Main constructor

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
BeamformerSettingsPane	getBeamformerSettingsPane()	Similar to the getSettingsPane() method, but does not load the latest parameters into the window.
Serializable	getSettingsReference()
long	getSettingsVersion()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class beamformer.BeamFormerBaseControl

findAlgorithmByName, getAlgorithmList, getBeamFormerParams, getBeamFormerProcess, setBeamFormerParams, setBeamFormerProcess

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

Field Details

unitType

public static String unitType

Constructor Details

BeamFormerControl

public BeamFormerControl(String unitName)

Main constructor

Parameters:

unitName -

Method Details

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

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.

getBeamformerSettingsPane

public BeamformerSettingsPane getBeamformerSettingsPane()

Similar to the getSettingsPane() method, but does not load the latest parameters into the window. Only returns a reference to the settings pane.

Returns:

the beamformerSettingsPane