Package PamController

Class PamSettingsGroup

java.lang.Object
PamController.PamSettingsGroup
All Implemented Interfaces:
Comparable<PamSettingsGroup>
public class PamSettingsGroup extends Object implements Comparable<PamSettingsGroup>
Stores a group of PAMGUARD settings read back from the database or some other store (e.g. binary storage).

The group of settings contains three things: 1) A time 2) A list of installed units 3) A list of settings (this is included as part of one of the unitSettings from Pam Controller)

Author:
Doug Gillespie
See Also:

  • Constructor Details

    • PamSettingsGroup

      public PamSettingsGroup(long settingsTime)
      Create a new settings unit, which will contain all the settings of a configuration at a particular time
      Parameters:
      settingsTime - settings time in milliseconds.

    • PamSettingsGroup

      public PamSettingsGroup(long settingsTime, ArrayList<PamControlledUnitSettings> settings)
      Constructor to use when a whole list of settings is already available.
      Parameters:
      settingsTime -
      settings -

  • Method Details

    • compareTo

      public int compareTo(PamSettingsGroup o)
      Specified by:
      compareTo in interface Comparable<PamSettingsGroup>

    • getSettingsTime

      public long getSettingsTime()
      Returns:
      the millisecond timestamp of the unit settings

    • setSettingsTime

      public void setSettingsTime(long settingsTime)
      Parameters:
      settingsTime - the settingsTime to set

    • addSettings

      public void addSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Add settings to the list of different unit settings
      Parameters:
      pamControlledUnitSettings - new settings

    • getUnitSettings

      public ArrayList<PamControlledUnitSettings> getUnitSettings()
      Returns:
      the complete array list of different unit settings

    • getUnitSettings

      public PamControlledUnitSettings getUnitSettings(int settingsNo)
      Get a particular set of settings.
      Parameters:
      settingsNo - Settings number
      Returns:
      unit settings

    • findUnitSettings

      public PamControlledUnitSettings findUnitSettings(String unitType, String unitName)
      find the unit settings for a module of a given name and type.
      Parameters:
      unitType - unit type
      unitName - unit name
      Returns:
      unit settings, or null if none found

    • getUsedModuleInfo

      public ArrayList<UsedModuleInfo> getUsedModuleInfo()
      Return the list of used modules. These were / are settings returned by the PamController.
      Returns:
      list of used modules.