alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy Class Reference

Inheritance diagram for alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy:

[legend]

Collaboration diagram for alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy:

[legend]

List of all members.

Public Member Functions
	ACSAlarmSystemInterfaceProxy (String name, Logger logger)
void	setSourceName (String newSourceName)
String	getSourceName ()
void	close ()
void	push (ACSFaultState state)
void	push (Collection states)
void	pushActiveList (Collection active)
Package Attributes
String	name
Private Member Functions
void	logFaultState (ACSFaultState fs)
Private Attributes
Logger	m_logger

---

Detailed Description

ACS implementation of the AlarmSystemInterface. The alarms are published in the logging.

Author:

acaproni

---

Constructor & Destructor Documentation

alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::ACSAlarmSystemInterfaceProxy	(	String	name,
		Logger	logger
	)			[inline]

The basic constructor

Parameters:

	name	The name of the source
	logger	The logger to log alarms in

References m_logger.

---

Member Function Documentation

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::close

(

)

[inline]

Close and deallocate resources.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

String alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::getSourceName

(

)

[inline]

Get the source name.

Returns:

the source name.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

References name.

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::logFaultState

(

ACSFaultState

fs

)

[inline, private]

Write the ACSFaultState in the log

Parameters:

fs

The ACSFaultState to log

References alma::alarmsystem::source::ACSFaultState::getCode(), alma::alarmsystem::source::ACSFaultState::getDescriptor(), alma::alarmsystem::source::ACSFaultState::getFamily(), alma::alarmsystem::source::ACSFaultState::getMember(), and m_logger.

Referenced by push().

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::push

(

Collection

states

)

[inline]

Push a collection of fault states.

Parameters:

states

Exceptions:

ASIException

if the fault state collection can not be pushed.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

References push().

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::push

(

ACSFaultState

state

)

[inline]

Push a fault state.

Parameters:

state

the fault state change to push.

Exceptions:

ASIException

if the fault state can not be pushed.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

References logFaultState().

Referenced by push(), and pushActiveList().

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::pushActiveList

(

Collection

active

)

[inline]

Push the set of active fault states.

Parameters:

active

the active fault states.

Exceptions:

ASIException

if the fault state active list can not be pushed.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

References push().

void alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::setSourceName

(

String

newSourceName

)

[inline]

Set the source name.

Parameters:

newSourceName

the source name.

Implements alma::alarmsystem::source::ACSAlarmSystemInterface.

References name.

---

Member Data Documentation

Logger alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::m_logger [private]

Referenced by ACSAlarmSystemInterfaceProxy(), and logFaultState().

String alma::alarmsystem::source::ACSAlarmSystemInterfaceProxy::name [package]

Referenced by getSourceName(), and setSourceName().

---

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

• ACSAlarmSystemInterfaceProxy.java