alarm.actions

Class AlarmAction

java.lang.Object

alarm.actions.AlarmAction

Direct Known Subclasses:

ActionSendEmail, AlarmSerialAction, PlaySound

public abstract class AlarmAction
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALARM_CAN_DO
static int	ALARM_CANT_DO
static int	ALARM_DONT_KNOW

Constructor Summary

Constructors

Constructor and Description
AlarmAction(AlarmControl alarmControl)

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	actOnAlarm(AlarmDataUnit alarmDataUnit) Act on the alarm - called every time the data unit is updated.
abstract int	canDo() Alarm action can complete (i.e.
abstract java.lang.String	getActionName()
abstract boolean	hasSettings()
boolean	prepareAction() Called when PAMGuard initialises to prepare any alarm actions, e.g.
abstract boolean	setSettings(java.awt.Window window) Open an action specific dialog to configure the action

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALARM_CANT_DO

public static final int ALARM_CANT_DO

See Also:

Constant Field Values

ALARM_CAN_DO

public static final int ALARM_CAN_DO

See Also:

Constant Field Values

ALARM_DONT_KNOW

public static final int ALARM_DONT_KNOW

See Also:

Constant Field Values

Constructor Detail

AlarmAction

public AlarmAction(AlarmControl alarmControl)

Method Detail

getActionName

public abstract java.lang.String getActionName()

Returns:

the name of the alarm action

hasSettings

public abstract boolean hasSettings()

Returns:

true if the action has configurable settings

setSettings

public abstract boolean setSettings(java.awt.Window window)

Open an action specific dialog to configure the action

Parameters:

window - parent window

Returns:

true if settings changed.

actOnAlarm

public abstract boolean actOnAlarm(AlarmDataUnit alarmDataUnit)

Act on the alarm - called every time the data unit is updated.

Parameters:

alarmDataUnit - alarm data unit that has changed.

Returns:

true if action completed ok

canDo

public abstract int canDo()

Alarm action can complete (i.e. some tests have been conducted)

Returns:

0 = no, 1 = yes, -1 = don't know.

prepareAction

public boolean prepareAction()

Called when PAMGuard initialises to prepare any alarm actions, e.g. open a serial port, find a file, etc.

Returns:

true if preparation completed Ok.