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 Link icon

    • tdMainDisplay Link icon

      protected TDDisplayFX tdMainDisplay
      Reference to the main node for the graph.
  • Constructor Details Link icon

    • TDControl Link icon

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

    • removeTDDataInfo Link icon

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

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

      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 Link icon

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

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

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

      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 Link icon

      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 Link icon

      public TDParametersFX getTdParameters()
    • setTDDisplay Link icon

      protected void setTDDisplay(TDDisplayFX tdDisplayFX)
    • getTDDisplay Link icon

      protected TDDisplayFX getTDDisplay()
    • isPaused Link icon

      public boolean isPaused()
    • dataModelToDisplay Link icon

      public void dataModelToDisplay()
    • isViewer Link icon

      public boolean isViewer()
      Check whether PAMGUARD is in viewer mode.
      Returns:
      true if in viewer mode.
    • getDataObserver Link icon

      public abstract PamObserver getDataObserver()
    • isStopped Link icon

      public boolean isStopped()
    • isRunning Link icon

      public boolean isRunning()
    • getUniqueName Link icon

      public String getUniqueName()
    • setUniqueName Link icon

      public void setUniqueName(String uniqueName)
    • newSelectedDetectionGroup Link icon

      public void newSelectedDetectionGroup(DetectionGroupSummary detectionGroup, TDGraphFX tdGraph)
      A new detection group has been selected.
      Parameters:
      detectionGroup - - the detection group that has been selected
    • updateProviderRegister Link icon

      public void updateProviderRegister()
      Update the provider register. This removes any data block which no longer exist in the data model.