public class ClickControl extends PamControlledUnit implements PamSettings
ClickControl contains both the detector and the display panel. It also contains information on Detection and Display menus which will get added to the main PamGuard menu.
Constructor and Description |
---|
ClickControl(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
void |
addOtherRelatedMenuItems(java.awt.Frame parentFrame,
javax.swing.JMenu menu,
java.lang.String name) |
void |
batchConvertClickDatabase(java.awt.Frame parentFrame) |
boolean |
canClose()
Called before Pamguard shuts down.
|
boolean |
canPlayViewerSound() |
boolean |
classificationDialog(java.awt.Frame pf)
Opens the offline click dialog.
|
javax.swing.JMenu |
createDetectionMenu(java.awt.Frame parentFrame)
Create a JMenu object containing MenuItems associated with PamProcesses
|
javax.swing.JMenu |
createDisplayMenu(java.awt.Frame parentFrame)
Create a JMenu object containing MenuItems associated with the view
|
void |
deleteEvent(OfflineEventDataUnit event)
Delete an offline event.
|
void |
displayActivated(ClickDisplay clickDisplay) |
void |
displayTriggerHistogram(TriggerHistogram[] triggerHistogram) |
AlarmCounterProvider |
getAlarmCounterProvider()
Get the counting system for the click alarm.
|
ClickClassifierManager |
getClassifierManager() |
ClickDataBlock |
getClickDataBlock()
Get the datablock containing click data
|
ClickDetector |
getClickDetector() |
ClickIdentifier |
getClickIdentifier() |
ClickParameters |
getClickParameters() |
ClicksOffline |
getClicksOffline() |
java.lang.String |
getDataBlockPrefix()
Solve problems with all click data blocks being called the same thing
if multiple click detectors are in the system.
|
ClickDisplayManager |
getDisplayManager() |
EchoDetectionSystem |
getEchoDetectionSystem() |
OfflineEventDataUnit |
getLatestOfflineEvent() |
java.lang.String |
getModuleSummary()
Get a module summary text string for shorthand output to
summary QC systems.
|
OfflineToolbar |
getOfflineToolbar() |
java.io.Serializable |
getSettingsReference() |
long |
getSettingsVersion() |
java.lang.Object |
getShortUnitType() |
javax.swing.JMenuBar |
getTabSpecificMenuBar(java.awt.Frame parentFrame,
javax.swing.JMenuBar standardMenu,
PamGui pamGui)
Create a tab specific menu to go with this PamControlledUnit.
|
TargetMotionLocaliser<OfflineEventDataUnit> |
getTargetMotionLocaliser() |
int |
getTrueChannelNumber(int iCh) |
void |
gotoEvent(OfflineEventDataUnit event)
Scrolls the display to a specific event.
|
boolean |
isViewerMode()
Speedier way of knowing if it's viewer mode than going back to the controller every time
|
void |
notifyModelChanged(int changeType)
General notification when the PAMGAURD model changes.
|
void |
notifyNewStorage(java.lang.String storageName) |
void |
offlineDataChanged()
Called from clicksOffline when data have changed (eg from re doing click id).
|
void |
pamStart() |
void |
pamStop() |
void |
playClicks() |
void |
playViewerSound()
Start playing sound in reponse to a call from the viewer top toolbar.
|
boolean |
restoreSettings(PamControlledUnitSettings pamControlledUnitSettings) |
void |
secondTimer(long sampleNumber) |
void |
setClassifierManager(ClickClassifierManager classifierManager) |
void |
setClickIdentifier(ClickIdentifier clickIdentifier) |
void |
setClickParameters(ClickParameters clickParameters) |
void |
setEchoDetectionSystem(EchoDetectionSystem echoDetectionSystem) |
void |
setLatestOfflineEvent(OfflineEventDataUnit latestOfflineEvent) |
void |
setupControlledUnit()
called for all PamControlledUnits after all units have been created.
|
void |
showOfflineEvents(java.awt.Frame frame)
Show a list of offline events.
|
addOfflineTaskGroup, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getSidePanel, getTabClipCopier, getTabPanel, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, stopViewerSound, terminalPrint, terminalPrintln, toString
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
getUnitName, getUnitType
public ClickDataBlock getClickDataBlock()
public boolean isViewerMode()
public void secondTimer(long sampleNumber)
public int getTrueChannelNumber(int iCh)
public void displayTriggerHistogram(TriggerHistogram[] triggerHistogram)
public void notifyNewStorage(java.lang.String storageName)
public javax.swing.JMenu createDetectionMenu(java.awt.Frame parentFrame)
PamControlledUnit
createDetectionMenu
in class PamControlledUnit
parentFrame
- The owner frame of the menuNote 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.
public javax.swing.JMenu createDisplayMenu(java.awt.Frame parentFrame)
PamControlledUnit
createDisplayMenu
in class PamControlledUnit
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.
public void notifyModelChanged(int changeType)
PamControlledUnit
notifyModelChanged
in class PamControlledUnit
changeType
- type of changepublic boolean classificationDialog(java.awt.Frame pf)
pf
- framepublic void batchConvertClickDatabase(java.awt.Frame parentFrame)
public ClickDetector getClickDetector()
public void pamStart()
public void pamStop()
public boolean canClose()
PamControlledUnit
canClose
in class PamControlledUnit
public long getSettingsVersion()
getSettingsVersion
in interface PamSettings
public java.io.Serializable getSettingsReference()
getSettingsReference
in interface PamSettings
public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
restoreSettings
in interface PamSettings
public javax.swing.JMenuBar getTabSpecificMenuBar(java.awt.Frame parentFrame, javax.swing.JMenuBar standardMenu, PamGui pamGui)
PamControlledUnit
Default is to throw back the standard menu to be used. This function should clone the standard menu and then modify the clone (usually by replacing the Display sub menu)
getTabSpecificMenuBar
in class PamControlledUnit
standardMenu
- the standard menu for the Pam GUI.public void addOtherRelatedMenuItems(java.awt.Frame parentFrame, javax.swing.JMenu menu, java.lang.String name)
addOtherRelatedMenuItems
in class PamControlledUnit
public void setupControlledUnit()
PamControlledUnit
setupControlledUnit
in class PamControlledUnit
public ClickIdentifier getClickIdentifier()
public void setClickIdentifier(ClickIdentifier clickIdentifier)
public void setClassifierManager(ClickClassifierManager classifierManager)
classifierManager
- the classifierManager to setpublic ClickClassifierManager getClassifierManager()
public ClickParameters getClickParameters()
public void setClickParameters(ClickParameters clickParameters)
public void offlineDataChanged()
public OfflineToolbar getOfflineToolbar()
public ClicksOffline getClicksOffline()
public OfflineEventDataUnit getLatestOfflineEvent()
public void setLatestOfflineEvent(OfflineEventDataUnit latestOfflineEvent)
latestOfflineEvent
- the latestOfflineEvent to setpublic void showOfflineEvents(java.awt.Frame frame)
frame
- public void gotoEvent(OfflineEventDataUnit event)
event
- event to scroll topublic void deleteEvent(OfflineEventDataUnit event)
event
- event to delete.public boolean canPlayViewerSound()
canPlayViewerSound
in class PamControlledUnit
public void playViewerSound()
PamControlledUnit
playViewerSound
in class PamControlledUnit
public void playClicks()
public EchoDetectionSystem getEchoDetectionSystem()
public void setEchoDetectionSystem(EchoDetectionSystem echoDetectionSystem)
echoDetectionSystem
- the echoDetectionSystem to setpublic void displayActivated(ClickDisplay clickDisplay)
public ClickDisplayManager getDisplayManager()
public java.lang.String getDataBlockPrefix()
public java.lang.String getModuleSummary()
PamControlledUnit
getModuleSummary
in class PamControlledUnit
public java.lang.Object getShortUnitType()
getShortUnitType
in class PamControlledUnit
public AlarmCounterProvider getAlarmCounterProvider()
alarmControl
- public TargetMotionLocaliser<OfflineEventDataUnit> getTargetMotionLocaliser()