alma.acs.alarmsystem.source.AlarmSender Class Reference

List of all members.

Public Member Functions
	AlarmSender (ContainerServicesBase containerServices)
void	sendAlarm (String FF, String FM, int FC, Properties properties, boolean active)
void	sendAlarm (String FF, String FM, int FC, boolean active)
void	close ()

---

Detailed Description

A support class for sending alarms.

Author:

acaproni

---

Constructor & Destructor Documentation

alma.acs.alarmsystem.source.AlarmSender.AlarmSender

(

ContainerServicesBase

containerServices

)

Constructor

Parameters:

containerServices

The ContainerServicesBase

---

Member Function Documentation

void alma.acs.alarmsystem.source.AlarmSender.close

(

)

Closes the alarm sending and frees the resources.

This is the last method to be executed: after it is not possible to send alarms anymore.

Referenced by alma.acs.alarmsystem.source.AlarmSourceImpl.tearDown().

void alma.acs.alarmsystem.source.AlarmSender.sendAlarm	(	String	FF,
		String	FM,
		int	FC,
		Properties	properties,
		boolean	active
	)

Send an alarm with user properties

Parameters:

	FF	The fault family
	FM	The fault member
	FC	The fault code
	properties	The properties (can be null or empty)
	active	If true the alarm is activated otherwise it is terminated

References alma.acs.container.ContainerServicesBase.getLogger(), alma.alarmsystem.source.ACSAlarmSystemInterface.push(), alma.alarmsystem.source.ACSFaultState.setDescriptor(), alma.alarmsystem.source.ACSFaultState.setUserProperties(), and alma.alarmsystem.source.ACSFaultState.setUserTimestamp().

Referenced by alma.acs.alarmsystem.source.AlarmSourceImpl.raiseAlarm(), and alma.acs.alarmsystem.source.AlarmSender.sendAlarm().

void alma.acs.alarmsystem.source.AlarmSender.sendAlarm	(	String	FF,
		String	FM,
		int	FC,
		boolean	active
	)

Send an alarm with no user properties

Parameters:

	FF	The fault family
	FM	The fault member
	FC	The fault code
	active	If true the alarm is activated otherwise it is terminated

See also:

AlarmSender.sendAlarm(String, String, int, Properties, boolean)

References alma.acs.alarmsystem.source.AlarmSender.sendAlarm().

---

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

• jacsalarm/src/alma/acs/alarmsystem/source/AlarmSender.java