Package dataPlotsFX

Class TDControl

java.lang.Object
dataPlotsFX.TDControl
All Implemented Interfaces:
PamSettings, SettingsNameProvider
Direct Known Subclasses:
TDControlAWT, TDControlFX
public abstract class TDControl extends Object implements PamSettings
The main class for the TDDisplay.
Author:
Jamie Macaulay

  • Field Details

    • tdMainDisplay

      protected TDDisplayFX tdMainDisplay
      Reference to the main node for the graph.

  • Constructor Details

    • TDControl

      public TDControl(String uniqueDisplayName)
      Flag for development features.

  • Method Details

    • removeTDDataInfo

      protected void removeTDDataInfo(TDDataInfoFX tdDataInfoFX)
      Remove a TDDataInfo which is currently being displayed.
      Parameters:
      tdDataInfoFX -

    • addDataBlock

      protected void addDataBlock(PamDataBlock pamDataBlock)
      Add a data block to be displayed.
      Parameters:
      pamDataBlock - - the data block to add to the display

    • getUnitName

      public String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      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

      protected Serializable 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

      public TDParametersFX getTdParameters()

    • setTDDisplay

      protected void setTDDisplay(TDDisplayFX tdDisplayFX)

    • getTDDisplay

      protected TDDisplayFX 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

      public abstract PamObserver getDataObserver()

    • isStopped

      public boolean isStopped()

    • isRunning

      public boolean isRunning()

    • getUniqueName

      public String getUniqueName()

    • setUniqueName

      public void setUniqueName(String uniqueName)

    • newSelectedDetectionGroup

      public void newSelectedDetectionGroup(DetectionGroupSummary detectionGroup, TDGraphFX tdGraph)
      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.