ACS-10.0 Java API: alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy Class Reference

Inheritance diagram for alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy:

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< ACSFaultState > states)
void	pushActiveList (Collection< ACSFaultState > active)
Package Attributes
String	name

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
	)

The basic constructor

Parameters:

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

Member Function Documentation

void alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.close ( )

Close and deallocate resources.

Implements alma.alarmsystem.source.ACSAlarmSystemInterface.

String alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.getSourceName ( )

Get the source name.

Returns:: the source name.

Implements alma.alarmsystem.source.ACSAlarmSystemInterface.

References alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.name.

void alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.push ( Collection< ACSFaultState > states )

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 alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.push().

void alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.push ( ACSFaultState state )

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.

Referenced by alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.push(), and alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.pushActiveList().

void alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.pushActiveList ( Collection< ACSFaultState > active )

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 alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.push().

void alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.setSourceName ( String newSourceName )

Set the source name.

Parameters:

newSourceName

the source name.

Implements alma.alarmsystem.source.ACSAlarmSystemInterface.

References alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.name.

Member Data Documentation

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

Referenced by alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.getSourceName(), and alma.alarmsystem.source.ACSAlarmSystemInterfaceProxy.setSourceName().

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

ACSAlarmSystemInterfaceProxy.java

All Classes Namespaces Files Functions Variables Enumerations Properties