Package soundtrap
Class STClickControl
java.lang.Object
PamController.PamControlledUnit
clickDetector.ClickControl
soundtrap.STClickControl
- All Implemented Interfaces:
 LocalisationAlgorithm,PamSensor,PamSettings,SettingsNameProvider
- Author:
 - mo55
 
- 
Field Summary
FieldsFields inherited from class clickDetector.ClickControl
angleVetoes, clickAlarmManager, clickControl, clickDetector, clickPanel, clickParameters, clickSidePanel, clickTrainDetector, echoDetectionSystem, rightMouseMenu, tabPanelControl, trackedClickLocaliser, UNITTYPEFields inherited from class PamController.PamControlledUnit
isMixed, isViewer - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptioncreateDetectionMenu(Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcessesReturns the raw data blockorg.pamguard.x3.sud.SUDClickDetectorInfovoidnotifyModelChanged(int changeType) General notification when the PAMGAURD model changes.voidpamStart()voidpamStop()booleanrestoreSettings(PamControlledUnitSettings pamControlledUnitSettings) voidsetSudClickDetectorInfo(org.pamguard.x3.sud.SUDClickDetectorInfo sudClickDetectorInfo) protected voidshowSudParameters(Frame parentFrame) voidupdateDisplayScrollers(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, clickedOnClick, 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, newRawData, notifyNewStorage, offlineDataChanged, playClicks, playViewerSound, reassignEventClicks, removeFromEvents, removeUnit, secondTimer, setClassifierManager, setClickIdentifier, setClickParameters, setEchoDetectionSystem, setLatestOfflineEvent, setupControlledUnit, showOfflineEventsMethods 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, getUnitTaskManager, getUnitTaskManager, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setUnitTaskManager, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface PamController.PamSensor
getUnitNameMethods inherited from interface PamController.SettingsNameProvider
getUnitName 
- 
Field Details
- 
STUNITTYPE
- See Also:
 
 
 - 
 - 
Constructor Details
- 
STClickControl
- Parameters:
 name-
 
 - 
 - 
Method Details
- 
findRawDataBlock
Description copied from class:ClickControlReturns the raw data block- Overrides:
 findRawDataBlockin classClickControl- Returns:
 
 - 
getUnitType
- Specified by:
 getUnitTypein interfacePamSensor- Specified by:
 getUnitTypein interfacePamSettings- Overrides:
 getUnitTypein classPamControlledUnit- Returns:
 - A Name specific to the type, e.g. Click detector
 
 - 
getSTAcquisition
 - 
createDetectionMenu
Description copied from class:PamControlledUnitCreate a JMenu object containing MenuItems associated with PamProcesses- Overrides:
 createDetectionMenuin 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.
 
 - 
showSudParameters
 - 
pamStart
public void pamStart()- Overrides:
 pamStartin classClickControl
 - 
pamStop
public void pamStop()- Overrides:
 pamStopin classClickControl
 - 
notifyModelChanged
public void notifyModelChanged(int changeType) Description copied from class:PamControlledUnitGeneral notification when the PAMGAURD model changes.- Overrides:
 notifyModelChangedin 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:
 restoreSettingsin interfacePamSettings- Overrides:
 restoreSettingsin classClickControl- 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
 
 - 
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:
 getSensorDescriptionin interfacePamSensor
 - 
getSensorId
- Specified by:
 getSensorIdin interfacePamSensor
 
 -