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
  • Constructor Details

    • TDControl

      public TDControl(String uniqueDisplayName)
      Flag for development features.
  • Method Details

    • 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
      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
    • getTdParameters

      public TDParametersFX getTdParameters()
    • 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