Package difar
Class DifarControl
java.lang.Object
PamController.PamControlledUnit
difar.DifarControl
- All Implemented Interfaces:
 PamSettings,SettingsNameProvider
- 
Field Summary
FieldsFields inherited from class PamController.PamControlledUnit
isMixed, isViewer - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptionbooleancanDemux()Can the system handle demuxing the next data unit ? Currently used to enable menus on the clip displaycreateDetectionMenu(Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcessescreateDisplayMenu(Frame parentFrame) Create a JMenu object containing MenuItems associated with the viewbooleandisplayMenu(Frame parentFrame) getClipDisplayParams(DifarDataUnit difarDataUnit) Allow the user to select the default classification for clips generated by manually marking the spectrogramlonggetSpeciesSymbol(DifarDataUnit difarDataUnit) Get the appropriate symbol for the selected species (or none).booleanbooleanbooleanbooleanisTrackedGroupSelectable(String groupName) loadClassificationParams(Frame frame, DifarParameters difarParameters) voidnotifyModelChanged(int changeType) General notification when the PAMGAURD model changes.booleanCalled to remove a unit.booleanrestoreSettings(PamControlledUnitSettings pamControlledUnitSettings) booleansaveClassificationParams(Window frame, LookupList speciesList, ArrayList<DifarParameters.SpeciesParams> speciesParams) Save a set of classifier params.voidsendDifarMessage(DIFARMessage message) Called from just about anywhere in the DIFAR system, this will process various difar messages and then pass the notification on to all the difar displays.voidsetCurrentlySelectedGroup(String groupName) booleansettingMenu(Frame parentFrame) setTrackedGroupProcess(TrackedGroupProcess trackedGroupProcess) voidMethods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, 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, getUnitTaskManager, getUnitTaskManager, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setUnitTaskManager, setupControlledUnit, 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.PamSettings
getUnitTypeMethods inherited from interface PamController.SettingsNameProvider
getUnitName 
- 
Field Details
- 
difarParameters
 - 
SPLITDISPLAYS
public static final boolean SPLITDISPLAYS- See Also:
 
 - 
sonobuoyManager
 
 - 
 - 
Constructor Details
- 
DifarControl
 
 - 
 - 
Method Details
- 
removeUnit
public boolean removeUnit()Description copied from class:PamControlledUnitCalled to remove a unit.- Overrides:
 removeUnitin classPamControlledUnit- Returns:
 - try (not used)
 
 - 
getSettingsReference
- Specified by:
 getSettingsReferencein interfacePamSettings- Returns:
 - The serialisable object that will be stored
 
 - 
getSettingsVersion
public long getSettingsVersion()- Specified by:
 getSettingsVersionin interfacePamSettings- Returns:
 - An integer version number for the settings
 
 - 
restoreSettings
- Specified by:
 restoreSettingsin interfacePamSettings- 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
 
 - 
sendDifarMessage
Called from just about anywhere in the DIFAR system, this will process various difar messages and then pass the notification on to all the difar displays.- Parameters:
 message- DIFAR message
 - 
getDifarDisplayContainer
 - 
getDifarDisplayContainer2
 - 
getSonobuoyManagerContainer
 - 
createDisplayMenu
Description copied from class:PamControlledUnitCreate a JMenu object containing MenuItems associated with the view- Overrides:
 createDisplayMenuin classPamControlledUnit- 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.
 
 - 
createDetectionMenu
Description copied from class:PamControlledUnitCreate a JMenu object containing MenuItems associated with PamProcesses- Overrides:
 createDetectionMenuin classPamControlledUnit- 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.
 
 - 
settingMenu
 - 
displayMenu
 - 
notifyModelChanged
public void notifyModelChanged(int changeType) Description copied from class:PamControlledUnitGeneral notification when the PAMGAURD model changes.- Overrides:
 notifyModelChangedin classPamControlledUnit- Parameters:
 changeType- type of change
 - 
getDifarGram
 - 
getDifarParameters
 - 
getDifarProcess
 - 
getInternalActionsPanel
 - 
getDifarQueue
 - 
getDemuxProgressDisplay
- Returns:
 - the demuxProgressDisplay
 
 - 
getClipDisplayParams
 - 
canDemux
public boolean canDemux()Can the system handle demuxing the next data unit ? Currently used to enable menus on the clip display- Returns:
 - true if it's OK to demux the next sound.
 
 - 
getDifarUnitControlPanel
- Returns:
 - the difarUnitControlPanel
 
 - 
getCurrentDemuxedUnit
- Returns:
 - the currentDemuxedUnit
 
 - 
getCurrentlySelectedGroup
 - 
setCurrentlySelectedGroup
 - 
isTrackedGroupSelectable
 - 
getSpeciesSymbol
Get the appropriate symbol for the selected species (or none).- Parameters:
 difarDataUnit- DIFAR data unit- Returns:
 - symbol or null if no species assigned.
 
 - 
getTrackedGroupProcess
 - 
setTrackedGroupProcess
 - 
saveClassificationParams
public boolean saveClassificationParams(Window frame, LookupList speciesList, ArrayList<DifarParameters.SpeciesParams> speciesParams) Save a set of classifier params. Since this is primarily an export function, it will always show the file save dialog- Parameters:
 speciesParams- parameters to save- Returns:
 - true if successful.
 
 - 
loadClassificationParams
 - 
getCurrentlySelectedSpecies
Allow the user to select the default classification for clips generated by manually marking the spectrogram- Returns:
 - - The species (DIFAR classification) selected by the user
 
 - 
getDefaultClassificationSelector
 - 
updateSidePanel
public void updateSidePanel() - 
isSaveEnabled
public boolean isSaveEnabled() - 
isSaveWithoutCrossEnabled
public boolean isSaveWithoutCrossEnabled() - 
isDeleteEnabled
public boolean isDeleteEnabled() 
 -