ACS-10.0 Java API: alma.acs.alarmsanalyzer.document.flood.AlarmFlood Class Reference

Inheritance diagram for alma.acs.alarmsanalyzer.document.flood.AlarmFlood:

List of all members.

Classes
class	AlarmPerMinute
Public Member Functions
	AlarmFlood (FloodContainer container)
long	lengthOfFlood ()
void	stop ()
void	run ()
synchronized void	onAlarm (Alarm alarm)
long	getStartTimeOfFlood ()
long	getEndTimeOfFlood ()
int	getAlarmsInFlood ()
boolean	isFloodStarted ()
boolean	isFloodFinished ()

Detailed Description

An alarm flood begins when the flow of annunciated alarms if greater then 10 alarms in 10 minutes and finish when the flow is less then 5 alarm in 10 minutes.

Objects of this class records a flood.

When the object is created, it starts a Thread to count each minute and for each minute the important value is the number of received alarms to recognize if a flood starts or finish.

The alarm counted in this context are the annunciated alarms i.e.

alarms active
alarms not reduced

Author:: acaproni

Constructor & Destructor Documentation

alma.acs.alarmsanalyzer.document.flood.AlarmFlood.AlarmFlood ( FloodContainer container )

Constructor

Parameters:

container

The container that owns this object

Member Function Documentation

int alma.acs.alarmsanalyzer.document.flood.AlarmFlood.getAlarmsInFlood ( )

Getter

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.getTotAlarmsInFloods().

long alma.acs.alarmsanalyzer.document.flood.AlarmFlood.getEndTimeOfFlood ( )

Getter

long alma.acs.alarmsanalyzer.document.flood.AlarmFlood.getStartTimeOfFlood ( )

Getter

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.getTotTimeInFloods().

boolean alma.acs.alarmsanalyzer.document.flood.AlarmFlood.isFloodFinished ( )

Returns:: true if the flood finished A value of false means that a flood has not finished yet but it could as well be that it never started.

boolean alma.acs.alarmsanalyzer.document.flood.AlarmFlood.isFloodStarted ( )

Returns:: true if a flood started

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.getNumbers().

long alma.acs.alarmsanalyzer.document.flood.AlarmFlood.lengthOfFlood ( )

The length of a this flood in msec.

Returns:: The length of the flood. It is a negative number, if a flood started but it is not yet finished

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.getTotTimeInFloods().

synchronized void alma.acs.alarmsanalyzer.document.flood.AlarmFlood.onAlarm ( Alarm alarm )

A new alarm has been received.

Parameters:

alarm

The alarm

Implements alma.acs.alarmsanalyzer.engine.AlarmCategoryListener.

References cern.laser.client.data.Alarm.getStatus().

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.onAlarm().

void alma.acs.alarmsanalyzer.document.flood.AlarmFlood.run ( )

The thread check every minute the state of the flood and terminates when the flood finishes.

References alma.acs.alarmsanalyzer.document.flood.FloodContainer.doneFlood().

void alma.acs.alarmsanalyzer.document.flood.AlarmFlood.stop ( )

Stop counting

Referenced by alma.acs.alarmsanalyzer.document.flood.FloodContainer.shutdownContainer().

The documentation for this class was generated from the following file:

AlarmFlood.java

All Classes Namespaces Files Functions Variables Enumerations Properties