Package csw.alarm.models

Class AlarmMetadata

java.lang.Object

csw.alarm.models.AlarmMetadata

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public class AlarmMetadata
extends Object
implements scala.Product, Serializable

Represents the metadata of an alarm e.g. name, subsystem it belongs to, supported severities, etc. This information is read from the config file for alarms and stored in alarm store. Metadata is referred while setting the severity to validate the operation. An alarm does not change it's metadata in it's entire life span.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AlarmMetadata(Prefix prefix, String name, String description, String location, AlarmType alarmType, scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities, String probableCause, String operatorResponse, boolean isAutoAcknowledgeable, boolean isLatchable, ActivationStatus activationStatus)

Method Summary

Modifier and Type	Method	Description
ActivationStatus	activationStatus()
Key.AlarmKey	alarmKey()	Represents a unique alarm in the store
AlarmType	alarmType()
scala.collection.immutable.Set<FullAlarmSeverity>	allSupportedSeverities()	A collection of all severities the alarm can be raised to including Indeterminate and Okay
String	description()
boolean	isActive()	Represents whether the alarm is active or not
boolean	isAutoAcknowledgeable()
boolean	isLatchable()
String	location()
String	name()
String	operatorResponse()
Prefix	prefix()
String	probableCause()
scala.collection.immutable.Set<FullAlarmSeverity>	supportedSeverities()

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

AlarmMetadata

public AlarmMetadata(Prefix prefix,
 String name,
 String description,
 String location,
 AlarmType alarmType,
 scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities,
 String probableCause,
 String operatorResponse,
 boolean isAutoAcknowledgeable,
 boolean isLatchable,
 ActivationStatus activationStatus)

Method Details

prefix

public Prefix prefix()

name

public String name()

description

public String description()

location

public String location()

alarmType

public AlarmType alarmType()

supportedSeverities

public scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities()

probableCause

public String probableCause()

operatorResponse

public String operatorResponse()

isAutoAcknowledgeable

public boolean isAutoAcknowledgeable()

isLatchable

public boolean isLatchable()

activationStatus

public ActivationStatus activationStatus()

alarmKey

public Key.AlarmKey alarmKey()

Represents a unique alarm in the store

Returns:

an instance of AlarmKey composed of subsystem, component and name of the alarm

isActive

public boolean isActive()

Represents whether the alarm is active or not

Returns:

(undocumented)

allSupportedSeverities

public scala.collection.immutable.Set<FullAlarmSeverity> allSupportedSeverities()

A collection of all severities the alarm can be raised to including Indeterminate and Okay

Returns:

(undocumented)