alma::alarmsystem::core::alarms::LaserCoreFaultState Class Reference

Collaboration diagram for alma::alarmsystem::core::alarms::LaserCoreFaultState:

[legend]

List of all members.

Public Types
enum	LaserCoreFaultCodes {   CDB_UNAVAILABLE, ALARMS_CDB, CATEGORIES_CDB, JMS_INIT,   SOURCE_LISTENER }
Static Public Member Functions
static FaultState	createFaultState (LaserCoreFaultCodes FC, boolean active)
static FaultState	createFaultState (LaserCoreFaultCodes FC, Properties props, boolean active)
static ACSJMSTextMessage	createJMSMessage (FaultState fs, ContainerServicesBase cs) throws Exception
static String[]	getCoreAlarmIds ()
Static Public Attributes
static final String	FaultFamily = "AlarmSystem"
static final String	FaultMember = "AlarmService"
Static Private Attributes
static String	hostName = null

---

Detailed Description

An helper class to create fault states generated by the alarm component.

All the alarms generated by the alarm service belong to the AlarmSystem fault family and to the AlarmService fault member.

Author:

acaproni

---

Member Enumeration Documentation

enum alma::alarmsystem::core::alarms::LaserCoreFaultState::LaserCoreFaultCodes

The fault code of the alarms generated by the alarm service.

Author:

acaproni

Enumerator:

CDB_UNAVAILABLE
ALARMS_CDB
CATEGORIES_CDB
JMS_INIT
SOURCE_LISTENER

---

Member Function Documentation

static FaultState alma::alarmsystem::core::alarms::LaserCoreFaultState::createFaultState	(	LaserCoreFaultCodes	FC,
		Properties	props,
		boolean	active
	)			[inline, static]

Create a FaultState for a given fault code and a given set of user properties.

Parameters:

	FC	The fault code of the alarm
	props	The user properties
	active	true if the alarm is active

Returns:

The FaultState for the passed code

References createFaultState(), and cern::laser::source::alarmsysteminterface::FaultState::setUserProperties().

static FaultState alma::alarmsystem::core::alarms::LaserCoreFaultState::createFaultState	(	LaserCoreFaultCodes	FC,
		boolean	active
	)			[inline, static]

Create a FaultState for a given fault code.

Parameters:

	FC	The fault code of the alarm
	active	true if the alarm is active

Returns:

The FaultState for the passed code

References FaultFamily, FaultMember, cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setDescriptor(), and cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setUserTimestamp().

Referenced by createFaultState().

static ACSJMSTextMessage alma::alarmsystem::core::alarms::LaserCoreFaultState::createJMSMessage	(	FaultState	fs,
		ContainerServicesBase	cs
	)			throws Exception [inline, static]

Create an acs text jms message containing the passed fault state in form of XML (ASIMessage) in the body.

Parameters:

	fs	The FaultState to set in the message
	cs	The ContainerServicesBase

Returns:

The jms text message containing the fault state

References hostName, and com::cosylab::acs::jms::ACSJMSTextMessage::setText().

static String [] alma::alarmsystem::core::alarms::LaserCoreFaultState::getCoreAlarmIds

(

)

[inline, static]

Return the Ids of all the laser core alarms

Returns:

The array with the Ids of all the core alarms

References FaultFamily, and FaultMember.

---

Member Data Documentation

final String alma::alarmsystem::core::alarms::LaserCoreFaultState::FaultFamily = "AlarmSystem" [static]

The fault family of the alarms generated by the alarm service

Referenced by createFaultState(), and getCoreAlarmIds().

final String alma::alarmsystem::core::alarms::LaserCoreFaultState::FaultMember = "AlarmService" [static]

The fault member of the alarms generated by the alarm service

Referenced by createFaultState(), and getCoreAlarmIds().

String alma::alarmsystem::core::alarms::LaserCoreFaultState::hostName = null [static, private]

The host name

Referenced by createJMSMessage().

---

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

• LaserCoreFaultState.java