Package dataPlotsFX
Class TDControl
java.lang.Object
dataPlotsFX.TDControl
- All Implemented Interfaces:
PamSettings
,SettingsNameProvider
- Direct Known Subclasses:
TDControlAWT
,TDControlFX
The main class for the TDDisplay.
- Author:
- Jamie Macaulay
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addDataBlock
(PamDataBlock pamDataBlock) Add a data block to be displayed.void
abstract PamObserver
long
protected TDDisplayFX
boolean
isPaused()
boolean
boolean
boolean
isViewer()
Check whether PAMGUARD is in viewer mode.void
newSelectedDetectionGroup
(DetectionGroupSummary detectionGroup, TDGraphFX tdGraph) A new detection group has been selected.protected Serializable
Called just before settings are saved.protected void
removeTDDataInfo
(TDDataInfoFX tdDataInfoFX) Remove a TDDataInfo which is currently being displayed.boolean
restoreSettings
(PamControlledUnitSettings pamControlledUnitSettings) protected void
setTDDisplay
(TDDisplayFX tdDisplayFX) void
setUniqueName
(String uniqueName) void
Update the provider register.
-
Field Details
-
Constructor Details
-
Method Details
-
removeTDDataInfo
Remove a TDDataInfo which is currently being displayed.- Parameters:
tdDataInfoFX
-
-
addDataBlock
Add a data block to be displayed.- Parameters:
pamDataBlock
- - the data block to add to the display
-
getUnitName
- Specified by:
getUnitName
in interfaceSettingsNameProvider
- Returns:
- A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
-
getUnitType
- Specified by:
getUnitType
in interfacePamSettings
- Returns:
- A Name specific to the type, e.g. Click detector
-
getSettingsReference
- Specified by:
getSettingsReference
in interfacePamSettings
- Returns:
- The serialisable object that will be stored
-
getSettingsVersion
public long getSettingsVersion()- Specified by:
getSettingsVersion
in interfacePamSettings
- Returns:
- An integer version number for the settings
-
restoreSettings
- Specified by:
restoreSettings
in 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
-
prepareSerialisedSettings
Called just before settings are saved. Will have to go through all the graphs and get them to provide updated settings information to add to this since it's not kept up to date on the fly.- Returns:
- object to serialise.
-
getTdParameters
-
setTDDisplay
-
getTDDisplay
-
isPaused
public boolean isPaused() -
dataModelToDisplay
public void dataModelToDisplay() -
isViewer
public boolean isViewer()Check whether PAMGUARD is in viewer mode.- Returns:
- true if in viewer mode.
-
getDataObserver
-
isStopped
public boolean isStopped() -
isRunning
public boolean isRunning() -
getUniqueName
-
setUniqueName
-
newSelectedDetectionGroup
A new detection group has been selected.- Parameters:
detectionGroup
- - the detection group that has been selected
-
updateProviderRegister
public void updateProviderRegister()Update the provider register. This removes any data block which no longer exist in the data model.
-