IshmaelDetector

Class IshDetControl

java.lang.Object

PamController.PamControlledUnit

IshmaelDetector.IshDetControl

All Implemented Interfaces:

PamSettings

Direct Known Subclasses:

EnergySumControl, MatchFiltControl, SgramCorrControl

public abstract class IshDetControl
extends PamControlledUnit
implements PamSettings

Constructor Summary

Constructors

Constructor and Description
IshDetControl(java.lang.String controlName, java.lang.String unitName, IshDetParams ishDetParams) Initializer.

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame, java.lang.String menuString)
abstract PamDataBlock	getDefaultInputDataBlock() Return any old data block of the right type so that the detection process's input can get hooked up to something from the get-go.
abstract IshDetFnProcess	getNewDetProcess(PamDataBlock defaultDataBlock) Create a new IshDetProcess of the appropriate type and return it.
PamDataBlock	getOutputDataBlock()
void	pamToStart() called just before data acquisition starts.
void	prepareNonDetProcesses()
boolean	restoreSettings(PamControlledUnitSettings dummy) This is called after a settings file is read.
abstract void	showParamsDialog1(java.awt.Frame parentFrame)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, 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, notifyModelChanged, pamClose, pamHasStopped, playViewerSound, removePamProcess, removeUnit, 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

getSettingsReference, getSettingsVersion, getUnitName, getUnitType

Constructor Detail

IshDetControl

public IshDetControl(java.lang.String controlName,
             java.lang.String unitName,
             IshDetParams ishDetParams)

Initializer.

IMPORTANT: The subclass initializer should construct the ishDetParams to pass here. See EnergySumControl for an example.

Method Detail

getDefaultInputDataBlock

public abstract PamDataBlock getDefaultInputDataBlock()

Return any old data block of the right type so that the detection process's input can get hooked up to something from the get-go. The input is typically re-hooked when the settings file is read.

Returns:

PamDataBlock

getNewDetProcess

public abstract IshDetFnProcess getNewDetProcess(PamDataBlock defaultDataBlock)

Create a new IshDetProcess of the appropriate type and return it. For example, EnergySumControl returns an EnergySumProcess.

prepareNonDetProcesses

public void prepareNonDetProcesses()

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame,
                                        java.lang.String menuString)

showParamsDialog1

public abstract void showParamsDialog1(java.awt.Frame parentFrame)

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings dummy)

This is called after a settings file is read. The subclass should get newParams and clone it as ishDetParams before calling here.

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

pamToStart

public void pamToStart()

Description copied from class: PamControlledUnit

called just before data acquisition starts. Note that PamObservers get a call to setSampleRate anyway so this mainly needs to be used for display elements that may need their scales adjusted before startup.

Overrides:

pamToStart in class PamControlledUnit

getOutputDataBlock

public PamDataBlock getOutputDataBlock()