Package soundtrap
Class STClickControl
java.lang.Object
PamController.PamControlledUnit
clickDetector.ClickControl
soundtrap.STClickControl
- All Implemented Interfaces:
LocalisationAlgorithm
,PamSensor
,PamSettings
,SettingsNameProvider
- Author:
- mo55
-
Field Summary
Fields inherited from class clickDetector.ClickControl
UNITTYPE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateDetectionMenu
(Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcessesReturns the raw data blockorg.pamguard.x3.sud.SUDClickDetectorInfo
void
notifyModelChanged
(int changeType) General notification when the PAMGAURD model changes.void
pamStart()
void
pamStop()
boolean
restoreSettings
(PamControlledUnitSettings pamControlledUnitSettings) void
setSudClickDetectorInfo
(org.pamguard.x3.sud.SUDClickDetectorInfo sudClickDetectorInfo) void
updateDisplayScrollers
(long timeMillis) Called when running SUD file data to find and scroll the BT Display'sMethods inherited from class clickDetector.ClickControl
addOtherRelatedMenuItems, batchConvertClickDatabase, canClose, canPlayViewerSound, classificationDialog, createDisplayMenu, deleteEvent, displayActivated, displayTriggerHistogram, getAlarmCounterProvider, getAlgorithmInfo, getClassifierManager, getClickDataBlock, getClickDetector, getClickIdentifier, getClickParameters, getClicksOffline, getClickTrainDetector, getClickTypeMasterManager, getDataBlockPrefix, getDisplayManager, getEchoDetectionSystem, getFFTDataOrganiser, getGUI, getLatestOfflineEvent, getModuleSummary, getOfflineToolbar, getSettingsReference, getSettingsVersion, getShortUnitType, getTabSpecificMenuBar, getTargetMotionLocaliser, getTethysCreator, getTrueChannelNumber, gotoEvent, isViewerMode, notifyNewStorage, offlineDataChanged, playClicks, playViewerSound, reassignEventClicks, removeFromEvents, removeUnit, secondTimer, setClassifierManager, setClickIdentifier, setClickParameters, setEchoDetectionSystem, setLatestOfflineEvent, setupControlledUnit, showOfflineEvents
Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addPamProcess, addPamProcess, addRelatedMenuItems, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getSidePanel, getTabClipCopier, getTabPanel, getToolbarComponent, getUnitName, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, 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.PamSensor
getUnitName
Methods inherited from interface PamController.SettingsNameProvider
getUnitName
-
Field Details
-
STUNITTYPE
- See Also:
-
-
Constructor Details
-
STClickControl
- Parameters:
name
-
-
-
Method Details
-
findRawDataBlock
Description copied from class:ClickControl
Returns the raw data block- Overrides:
findRawDataBlock
in classClickControl
- Returns:
-
getUnitType
- Specified by:
getUnitType
in interfacePamSensor
- Specified by:
getUnitType
in interfacePamSettings
- Overrides:
getUnitType
in classPamControlledUnit
- Returns:
- A Name specific to the type, e.g. Click detector
-
getSTAcquisition
-
createDetectionMenu
Description copied from class:PamControlledUnit
Create a JMenu object containing MenuItems associated with PamProcesses- Overrides:
createDetectionMenu
in classClickControl
- 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.
-
pamStart
public void pamStart()- Overrides:
pamStart
in classClickControl
-
pamStop
public void pamStop()- Overrides:
pamStop
in classClickControl
-
notifyModelChanged
public void notifyModelChanged(int changeType) Description copied from class:PamControlledUnit
General notification when the PAMGAURD model changes.- Overrides:
notifyModelChanged
in classClickControl
- Parameters:
changeType
- type of change
-
updateDisplayScrollers
public void updateDisplayScrollers(long timeMillis) Called when running SUD file data to find and scroll the BT Display's- Parameters:
timeMillis
-
-
restoreSettings
- Specified by:
restoreSettings
in interfacePamSettings
- Overrides:
restoreSettings
in classClickControl
- 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
-
getSudClickDetectorInfo
public org.pamguard.x3.sud.SUDClickDetectorInfo getSudClickDetectorInfo()- Returns:
- the sudClickDetectorInfo
-
setSudClickDetectorInfo
public void setSudClickDetectorInfo(org.pamguard.x3.sud.SUDClickDetectorInfo sudClickDetectorInfo) - Parameters:
sudClickDetectorInfo
- the sudClickDetectorInfo to set
-
getSensorDescription
- Specified by:
getSensorDescription
in interfacePamSensor
-
getSensorId
- Specified by:
getSensorId
in interfacePamSensor
-