whistlesAndMoans.alarm

Class WMAlarmCounter

java.lang.Object

alarm.AlarmCounter

alarm.AlarmDecibelCounter

whistlesAndMoans.alarm.WMAlarmCounter

All Implemented Interfaces:

PamSettings

public class WMAlarmCounter
extends AlarmDecibelCounter
implements PamSettings

Constructor Summary

Constructors

Constructor and Description
WMAlarmCounter(AlarmControl alarmControl, WhistleMoanControl whistleMoanControl)

Method Summary

Methods

Modifier and Type	Method and Description
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
double	getValue(int countType, PamDataUnit dataUnit) Get a count value from a source of alarm trigger data
boolean	hasOptions()
void	resetCounter()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
boolean	showOptions(java.awt.Window parent) Show module specific options

Methods inherited from class alarm.AlarmDecibelCounter

addCount, subtractCount

Methods inherited from class alarm.AlarmCounter

getAlarmControl, getExtraFieldData, getExtraFieldNames

Methods inherited from class java.lang.Object

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

Constructor Detail

WMAlarmCounter

public WMAlarmCounter(AlarmControl alarmControl,
              WhistleMoanControl whistleMoanControl)

Method Detail

getValue

public double getValue(int countType,
              PamDataUnit dataUnit)

Description copied from class: AlarmCounter

Get a count value from a source of alarm trigger data

Two types of counting are available. COUNT_SIMPLE in which case each data unit scores either 0 or 1 and COUNT_SCORES in which case each unit is assigned a value (could still be 0 or 1 !)

Specified by:

getValue in class AlarmCounter

Parameters:

countType - type of counting

dataUnit - dataunit to consider

Returns:

value to add to trigger count.

resetCounter

public void resetCounter()

Specified by:

resetCounter in class AlarmCounter

hasOptions

public boolean hasOptions()

Overrides:

hasOptions in class AlarmCounter

Returns:

true if the counter has module specific options.

showOptions

public boolean showOptions(java.awt.Window parent)

Description copied from class: AlarmCounter

Show module specific options

Overrides:

showOptions in class AlarmCounter

Parameters:

parent - parent frame for dialog

Returns:

true if options were changed (false if cancel button pressed on dialog)

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

getSettingsReference

public java.io.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

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