Package alarm.actions.serial

Class AlarmSerialInterface

java.lang.Object
alarm.actions.serial.AlarmSerialInterface
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class AlarmSerialInterface extends Object implements PamSettings
Singleton class for all alarm actions to share a single serial port, it's settings etc.
Author:
Doug Gillespie

  • Method Details

    • getInstance

      public static final AlarmSerialInterface getInstance(AlarmControl alarmControl)

    • setSettings

      public boolean setSettings(Window window)

    • isPortOk

      public boolean isPortOk()

    • writeString

      public boolean writeString(String outputString)
      Write a string to the serial port.
      Parameters:
      outputString - string to write to serial port.
      Returns:
      true if string written successfully.

    • 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