Package alarm.actions.serial

Class AlarmSerialAction

java.lang.Object
alarm.actions.AlarmAction
alarm.actions.serial.AlarmSerialAction
Direct Known Subclasses:
TastAction
public class AlarmSerialAction extends AlarmAction
Alarm action for serial port output. Since all alarms will share a serial port, will need to wrap most of the functionality up in a singleton class that does the actual work of writing to the serial port.
Author:
Doug Gillespie

  • Constructor Details

    • AlarmSerialAction

      public AlarmSerialAction(AlarmControl alarmControl)

  • Method Details

    • getActionName

      public String getActionName()
      Specified by:
      getActionName in class AlarmAction
      Returns:
      the name of the alarm action

    • hasSettings

      public boolean hasSettings()
      Specified by:
      hasSettings in class AlarmAction
      Returns:
      true if the action has configurable settings

    • setSettings

      public boolean setSettings(Window window)
      Description copied from class: AlarmAction
      Open an action specific dialog to configure the action
      Specified by:
      setSettings in class AlarmAction
      Parameters:
      window - parent window
      Returns:
      true if settings changed.

    • actOnAlarm

      public boolean actOnAlarm(AlarmDataUnit alarmDataUnit)
      Description copied from class: AlarmAction
      Act on the alarm - called every time the data unit is updated.
      Specified by:
      actOnAlarm in class AlarmAction
      Parameters:
      alarmDataUnit - alarm data unit that has changed.
      Returns:
      true if action completed ok

    • canDo

      public int canDo()
      Description copied from class: AlarmAction
      Alarm action can complete (i.e. some tests have been conducted)
      Specified by:
      canDo in class AlarmAction
      Returns:
      0 = no, 1 = yes, -1 = don't know.

    • prepareAction

      public boolean prepareAction()
      Description copied from class: AlarmAction
      Called when PAMGuard initialises to prepare any alarm actions, e.g. open a serial port, find a file, etc.
      Overrides:
      prepareAction in class AlarmAction
      Returns:
      true if preparation completed Ok.