public class AlarmState
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
AlarmState data structure: ___________________________________________________________ overall alarms | native----new-----severity 1 total number | | |--severity 2 total number | | |--severity n total number | | | acknowledged----severity 1 total number | |--severity 2 total number | |--severity n total number | propagate alarm------------------------propagated severity ___________________________________________________________New alarms will change to acknowledged alarm via acknowledge action:
(new alarm)---------acknowledge-------->(acknowledged alarm)
Constructor and Description |
---|
AlarmState()
Default constructor
|
AlarmState(Element element)
Create alarm state object that is initialized with the given element as
the source element.
|
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAlarm(AlarmSeverity severity)
Acknowledges an alarm of a given severity.
|
void |
acknowledgeAllAlarms()
Acknowledges all alarms.
|
void |
acknowledgeAllAlarms(AlarmSeverity severity)
Acknowledges all alarms of a given severity.
|
void |
addAcknowledgedAlarm(AlarmSeverity severity)
Adds a acknowledged alarm with a given severity.
|
void |
addNewAlarm(AlarmSeverity severity)
Adds a new alarm with given severity.
|
void |
clear()
Removes all alarms, include all new, acknowledged or propagated alarms,
all alarm severities.
|
java.lang.Object |
clone() |
int |
compareTo(java.lang.Object o) |
void |
copyFrom(AlarmState alarmState) |
void |
decreaseAcknowledgedAlarm(AlarmSeverity severity,
int decrement)
Decrease acknowledged alarm count for given severity.
|
void |
decreaseNewAlarm(AlarmSeverity severity,
int decrement)
Decrease new alarm count for given severity.
|
int |
getAcknowledgedAlarmCount()
Returns the number of acknowledged alarms,
all alarm severities included.
|
int |
getAcknowledgedAlarmCount(AlarmSeverity severity)
Returns the total acknowledged alarm count of specified severity.
|
int |
getAlarmCount()
Returns the total number of alarms,
acknowledged or otherwise, all alarm severities included.
|
int |
getAlarmCount(AlarmSeverity severity)
Returns the total number of alarms with the specified severity,
acknowledged or new.
|
AlarmSeverity |
getHighestAcknowledgedAlarmSeverity()
Gets the highest acknowledged alarm severity
|
AlarmSeverity |
getHighestNativeAlarmSeverity()
Get the highest native alarm severity.
|
AlarmSeverity |
getHighestNewAlarmSeverity()
Get the highest new alarm severity
|
AlarmSeverity |
getHighestOverallAlarmSeverity()
Get the highest overall alarm severity.
|
int |
getNewAlarmCount()
Returns the number of all new alarms, all alarm severities included.
|
int |
getNewAlarmCount(AlarmSeverity severity)
Returns the total number of all new alarms of the given severity.
|
AlarmSeverity |
getPropagateSeverity()
Gets the propagate alarm severity.
|
boolean |
hasLessSevereNewAlarms()
Tells whether has non-highest severe new alarms.
|
void |
increaseAcknowledgedAlarm(AlarmSeverity severity,
int increment)
Increase acknowledged alarm count for given severity.
|
void |
increaseNewAlarm(AlarmSeverity severity,
int increment)
Increase new alarm count for given severity.
|
boolean |
isEmpty()
Tells whether this alarm state object has any alarms.
|
boolean |
isEnablePropagationFromChildren()
Returns true if the children's alarm state can
propagate to the related element of this alarm state.
|
void |
removeAcknowledgedAlarm(AlarmSeverity severity)
Removes an acknowledged alarm on the given severity.
|
void |
removeAllAcknowledgedAlarms()
Removes all acknowledged alarms of all severities.
|
void |
removeAllAcknowledgedAlarms(AlarmSeverity severity)
Removes all acknowledged alarms of the given severity.
|
void |
removeAllNewAlarms()
Removes all new alarms of all severities.
|
void |
removeAllNewAlarms(AlarmSeverity severity)
Removes all new alarms of the given severity.
|
void |
removeNewAlarm(AlarmSeverity severity)
Removes a new alarm on the given severity.
|
void |
setAcknowledgedAlarmCount(AlarmSeverity severity,
int count)
Sets a new total acknowledged alarm number for the given severity.
|
void |
setEnablePropagationFromChildren(boolean enablePropagationOfChildren)
Determines whether or not the children's alarm state can
propagate to the related element of this alarm state.
|
void |
setNewAlarmCount(AlarmSeverity severity,
int count)
Sets the new alarm total count for given severity.
|
void |
setPropagateSeverity(AlarmSeverity propagateSeverity)
Set the propagate alarm severity.
|
public AlarmState()
public AlarmState(Element element)
element
- Element the source elementpublic AlarmSeverity getHighestAcknowledgedAlarmSeverity()
public AlarmSeverity getHighestNewAlarmSeverity()
public boolean hasLessSevereNewAlarms()
public AlarmSeverity getHighestOverallAlarmSeverity()
public AlarmSeverity getHighestNativeAlarmSeverity()
public void increaseAcknowledgedAlarm(AlarmSeverity severity, int increment)
severity
- AlarmSeverity the severity need to be changed.increment
- int the number need to be increasedpublic void increaseNewAlarm(AlarmSeverity severity, int increment)
severity
- AlarmSeverity the severity need to be changed.increment
- int the number need to be increasedpublic void decreaseAcknowledgedAlarm(AlarmSeverity severity, int decrement)
severity
- AlarmSeverity the severity need to be changed.increment
- int the number need to be decreasedpublic void decreaseNewAlarm(AlarmSeverity severity, int decrement)
severity
- AlarmSeverity the severity need to be changed.increment
- int the number need to be decreasedpublic void acknowledgeAlarm(AlarmSeverity severity)
severity
- the severity need to be acknowledgedpublic void acknowledgeAllAlarms(AlarmSeverity severity)
severity
- the severity need to be acknowledgedpublic void acknowledgeAllAlarms()
public void addAcknowledgedAlarm(AlarmSeverity severity)
severity
- the severity need to be acknowledged.public void addNewAlarm(AlarmSeverity severity)
severity
- the severity need to be added.public int getAcknowledgedAlarmCount()
public int getAcknowledgedAlarmCount(AlarmSeverity severity)
severity
- AlarmSeverity the constraint severitypublic int getAlarmCount()
public int getAlarmCount(AlarmSeverity severity)
severity
- the severity constraintpublic int getNewAlarmCount()
public int getNewAlarmCount(AlarmSeverity severity)
severity
- AlarmSeverity the alarm severity constraintpublic void setNewAlarmCount(AlarmSeverity severity, int count)
AlarmSeverity
- the alarm severity constrainint
- the new total number for the specified severity.public void removeNewAlarm(AlarmSeverity severity)
decreaseNewAlarm(severity, 1)
AlarmSeverity
- the alarm severity constraintpublic void removeAllNewAlarms(AlarmSeverity severity)
AlarmSeverity
- the alarm severity constraintpublic void removeAllNewAlarms()
public void setAcknowledgedAlarmCount(AlarmSeverity severity, int count)
severity
- AlarmSeverity the alarm severity constraintcount
- int the new total acknowledged alarm number for the given severity.public void removeAcknowledgedAlarm(AlarmSeverity severity)
severity
- AlarmSeverity the alarm severity constraintpublic void removeAllAcknowledgedAlarms(AlarmSeverity severity)
severity
- AlarmSeverity severity constraintpublic void removeAllAcknowledgedAlarms()
public void clear()
public void copyFrom(AlarmState alarmState)
public AlarmSeverity getPropagateSeverity()
Please note that AlarmState does not save any number information for the propagate alarm. Only the propagate alarm severity provided.
public void setPropagateSeverity(AlarmSeverity propagateSeverity)
Note:In most cases, don't call this method to change the propagated
alarm severity out of an alarm propagator(see twaver.AlarmPropatator
).
Please note that AlarmState does not save any number information for the propagate alarm. Only the propagate alarm severity provided.
propagateSeverity
- AlarmSeverity the new propagate alarm severity.public boolean isEmpty()
public java.lang.Object clone()
clone
in class java.lang.Object
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public boolean isEnablePropagationFromChildren()
public void setEnablePropagationFromChildren(boolean enablePropagationOfChildren)
enablePropagationOfChildren
- booleanCopyright © 2002 - 2010 Serva Software. All Rights Reserved.