Package csw.alarm.models
Class AlarmMetadata
- java.lang.Object
-
- csw.alarm.models.AlarmMetadata
-
- All Implemented Interfaces:
java.io.Serializable
,scala.Equals
,scala.Product
public class AlarmMetadata extends java.lang.Object implements scala.Product, java.io.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, java.lang.String name, java.lang.String description, java.lang.String location, AlarmType alarmType, scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities, java.lang.String probableCause, java.lang.String operatorResponse, boolean isAutoAcknowledgeable, boolean isLatchable, ActivationStatus activationStatus)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ActivationStatus
activationStatus()
Key.AlarmKey
alarmKey()
Represents a unique alarm in the storeAlarmType
alarmType()
scala.collection.immutable.Set<FullAlarmSeverity>
allSupportedSeverities()
A collection of all severities the alarm can be raised to including Indeterminate and Okayabstract static R
apply(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11)
java.lang.String
description()
boolean
isActive()
Represents whether the alarm is active or notboolean
isAutoAcknowledgeable()
boolean
isLatchable()
java.lang.String
location()
java.lang.String
name()
java.lang.String
operatorResponse()
Prefix
prefix()
java.lang.String
probableCause()
scala.collection.immutable.Set<FullAlarmSeverity>
supportedSeverities()
static java.lang.String
toString()
-
-
-
Constructor Detail
-
AlarmMetadata
public AlarmMetadata(Prefix prefix, java.lang.String name, java.lang.String description, java.lang.String location, AlarmType alarmType, scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities, java.lang.String probableCause, java.lang.String operatorResponse, boolean isAutoAcknowledgeable, boolean isLatchable, ActivationStatus activationStatus)
-
-
Method Detail
-
apply
public abstract static R apply(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11)
-
toString
public static java.lang.String toString()
-
prefix
public Prefix prefix()
-
name
public java.lang.String name()
-
description
public java.lang.String description()
-
location
public java.lang.String location()
-
alarmType
public AlarmType alarmType()
-
supportedSeverities
public scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities()
-
probableCause
public java.lang.String probableCause()
-
operatorResponse
public java.lang.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)
-
-