alma.acs.alarm.gui.senderpanel

Class BaseAlarmsSender

java.lang.Object

alma.acs.alarm.gui.senderpanel.BaseAlarmsSender

Direct Known Subclasses:

CDBSender, FileSender

public class BaseAlarmsSender
extends java.lang.Object

The base class for alarms senders.

BaseAlarmsSender starts a thread, alarmsSenderThread, to randomly set/clear the alarms whose definition is read from the file.
There is only one thread alive at a given time. So if the user want to start a task, he must wait the termination of the current task or stop it.

Default fault members have a '*' in the FM of the triplet. Default fault members are used only while cycling i.e. when activating or terminating all the alarms they are ignored. The fault member name of a default is built by appending a random number to the prefix name, defaultFMNamePrefix. This means that the user must clean default fault members by using the table of alarms.

Author:

acaproni

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseAlarmsSender.AlarmRead An alarm read from the file or the TM/CDB.
protected static class	BaseAlarmsSender.AlarmSenderThreadFactory The thread factory to create threads for sending alarms.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<BaseAlarmsSender.AlarmRead>	alarms The alarms read from the file.
protected ParallelAlarmSender	alarmsSender The object to send alarms
protected java.lang.Thread	alarmsSenderThread The thread to send alarms.
protected ContainerServices	contSvcs ContainerServices
protected java.lang.String	defaultFMNamePrefix The prefix of a fault member generated from a default
protected java.util.Set<SlowTaskListener>	listeners The listeners to notify when alarms have been sent to the alarm system.
protected int	maxDefaultFMSuffix The max number appended to the prefix to build a fault member with a default
protected SenderPanel	panel The parent component to show the dialog
protected BaseAlarmsSender.AlarmSenderThreadFactory	threadFactory The factory to create threads

Constructor Summary

Constructors

Constructor and Description
BaseAlarmsSender(SenderPanel parent, ContainerServices contSvcs, ParallelAlarmSender sender, java.lang.String threadPrefixName) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	addSlowTaskListener(SlowTaskListener listener) Add a not null listener.
void	close() Stop the thread and frees the resources
protected void	dumpAlarms() Print on the stdout the alarms InterruptedException alarms
protected void	notifyAlarmsRead() Notify the listeners that the alarms have been read from the file or the TM/CDB
protected void	notifyStartTask(java.lang.Integer nSteps) Notify the listeners that a slow task started.
protected void	notifyStopTask() Notify the listeners that a slow task terminated.
protected void	notifyTaskProgress(int currentStep) Notify the listeners that a slow task terminated.
boolean	removeSlowTaskListener(SlowTaskListener listener) Remove a listener.
void	sendAlarms(boolean active) Send the alarms read from the file.
int	size()
void	startSendingRandomly() Start sending alarms randomly.
void	stopThread() Stop the thread to send alarms

Methods inherited from class java.lang.Object

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

Field Detail

defaultFMNamePrefix

protected final java.lang.String defaultFMNamePrefix

The prefix of a fault member generated from a default

See Also:

Constant Field Values

maxDefaultFMSuffix

protected final int maxDefaultFMSuffix

The max number appended to the prefix to build a fault member with a default

This is also the max number of alarms that can be generated for a default fault member i.e. an alarm like FF,*,1 can be translated into at most maxDefaultFMSuffix alarms

See Also:

Constant Field Values

contSvcs

protected final ContainerServices contSvcs

ContainerServices

alarmsSender

protected final ParallelAlarmSender alarmsSender

The object to send alarms

panel

protected final SenderPanel panel

The parent component to show the dialog

threadFactory

protected final BaseAlarmsSender.AlarmSenderThreadFactory threadFactory

The factory to create threads

alarmsSenderThread

protected volatile java.lang.Thread alarmsSenderThread

The thread to send alarms.

alarms

protected final java.util.Vector<BaseAlarmsSender.AlarmRead> alarms

The alarms read from the file.

listeners

protected final java.util.Set<SlowTaskListener> listeners

The listeners to notify when alarms have been sent to the alarm system.

Constructor Detail

BaseAlarmsSender

public BaseAlarmsSender(SenderPanel parent,
                        ContainerServices contSvcs,
                        ParallelAlarmSender sender,
                        java.lang.String threadPrefixName)

Constructor

Parameters:

parent - the parent component of the dialog

contSvcs - The ContainerServices

sender - The object to send alarms

threadPrefixName - The prefix of the name of the thread

Method Detail

stopThread

public void stopThread()

Stop the thread to send alarms

addSlowTaskListener

public boolean addSlowTaskListener(SlowTaskListener listener)

Add a not null listener.

Parameters:

listener - The listener to be notified

Returns:

true if this set did not already contain the specified element

removeSlowTaskListener

public boolean removeSlowTaskListener(SlowTaskListener listener)

Remove a listener.

Parameters:

listener - The not null listener to remove

Returns:

true if this set contained the specified element

close

public void close()

Stop the thread and frees the resources

notifyStartTask

protected void notifyStartTask(java.lang.Integer nSteps)

Notify the listeners that a slow task started.

Parameters:

nSteps - The number of steps or null if undefined.

notifyStopTask

protected void notifyStopTask()

Notify the listeners that a slow task terminated.

notifyTaskProgress

protected void notifyTaskProgress(int currentStep)

Notify the listeners that a slow task terminated.

Parameters:

currentStep - The actual step

notifyAlarmsRead

protected void notifyAlarmsRead()

Notify the listeners that the alarms have been read from the file or the TM/CDB

size

public int size()

Returns:

The number of alarms in memory i.e. the number of alarms read from the file

dumpAlarms

protected void dumpAlarms()

Print on the stdout the alarms InterruptedException alarms

sendAlarms

public void sendAlarms(boolean active)

Send the alarms read from the file.

Parameters:

active - if true the alarms are activated, otherwise terminated

startSendingRandomly

public void startSendingRandomly()

Start sending alarms randomly.

The triplet of alarms are those set in the file but they are picked up randomly in a loop. The activation state (ACTIVE, TERMINATE) is also chosen randomly