Package PamController

Interface PamSettingsSource

All Known Implementing Classes:
BinarySettingsStorage, BinaryStore, DBControl, DBControlSettings, DBControlUnit, ExternalDatabaseControl, SecondaryBinaryStore
public interface PamSettingsSource
Added to a PamControlledUnit which can save and reload PamSettings information from files, databases, etc.

Any PamControlledUnit implementing this class will be asked to save settings each time PAMGUARD starts and will be able to read back lists of timestamped settings from files.

Author:
Doug Gillespie.

  • Method Details

    • saveStartSettings

      boolean saveStartSettings(long timeNow)
      Save the settings in some way or another.
      Parameters:
      timeNow - current time.
      Returns:
      true if settings saved successfully

    • saveEndSettings

      boolean saveEndSettings(long timeNow)
      Save settings when processing ends. This may just be an update of the settings saves with saveStartSettings, e.g. an end time.
      Parameters:
      timeNow -
      Returns:
      true if saved correctly.

    • getNumSettings

      int getNumSettings()
      Get the number of different settings within the settings source.
      Returns:
      the number of PamSettingsGroups.

    • getSettings

      PamSettingsGroup getSettings(int settingsIndex)
      Get a specific PamSettingsGroup
      Parameters:
      settingsIndex - index of group
      Returns:
      a settings group

    • getSettingsSourceName

      String getSettingsSourceName()
      Get a name for the settings source
      Returns:
      a name