Package | twaver |
Class | public class AlarmStateStatistics |
Inheritance | AlarmStateStatistics ![]() |
Check TWaver Flex demo source code to find more example of this class usage.
Property | Defined By | ||
---|---|---|---|
elementBox : ElementBox
Get the connecting element box. | AlarmStateStatistics | ||
filterFunction : Function
Get the filter for this alarm statistics. | AlarmStateStatistics |
Method | Defined By | ||
---|---|---|---|
Creator. | AlarmStateStatistics | ||
addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this class to monitoring the
property change event. | AlarmStateStatistics | ||
dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event. | AlarmStateStatistics | ||
dispose():void
Dispose all resourced used by this class. | AlarmStateStatistics | ||
getAcknowledgedAlarmCount(severity:AlarmSeverity = null):int
Get total acknowledged alarm count for the connected element box and
the specified alarm severity. | AlarmStateStatistics | ||
getNewAlarmCount(severity:AlarmSeverity = null):int
Get total new alarm count for the connected element box and
the specified alarm severity. | AlarmStateStatistics | ||
getTotalAlarmCount(severity:AlarmSeverity = null):int
Get total alarm count for specified alarm severity. | AlarmStateStatistics | ||
removePropertyChangeListener(listener:Function):void
Remove the specified property change listener from this class. | AlarmStateStatistics | ||
reset():void
Call this to reset all numbers to zero. | AlarmStateStatistics |
elementBox | property |
elementBox:ElementBox
Get the connecting element box.
public function get elementBox():ElementBox
public function set elementBox(value:ElementBox):void
filterFunction | property |
filterFunction:Function
Get the filter for this alarm statistics. The filter give your a chance to filter out some elements or alarms that you don't want be calculated by this statistics. Default value is null, this means calculate all alarms for the connecting element box.
public function get filterFunction():Function
public function set filterFunction(value:Function):void
AlarmStateStatistics | () | Constructor |
public function AlarmStateStatistics(box:ElementBox)
Creator. This will create an alarm state statistics connecting to the specified element box.
Parametersbox:ElementBox — the element box will connect to current alarm state object.
|
addPropertyChangeListener | () | method |
public function addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this class to monitoring the property change event.
Parameters
listener:Function — the listener to be added
| |
priority:int (default = 0 ) — listener priority
| |
useWeakReference:Boolean (default = false ) — whether use weak reference
|
dispatchPropertyChangeEvent | () | method |
public function dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event.
Parameters
property:String — the property name changed
| |
oldValue:Object — the old value before changed
| |
newValue:Object — the new value to be changed
|
Boolean — true true means dispatched, false means not.
|
dispose | () | method |
public function dispose():void
Dispose all resourced used by this class. Call this method if you want disconnect the connecting element databox. Most of the time you don't need to invoke this to dispose the resourced unless you really want disconnect to an element box.
getAcknowledgedAlarmCount | () | method |
public function getAcknowledgedAlarmCount(severity:AlarmSeverity = null):int
Get total acknowledged alarm count for the connected element box and the specified alarm severity.
Parameters
severity:AlarmSeverity (default = null ) — the alarm severity to be counted
|
int — the total acknowledged alarm count for the connected element box and
the specified alarm severity.
|
getNewAlarmCount | () | method |
public function getNewAlarmCount(severity:AlarmSeverity = null):int
Get total new alarm count for the connected element box and the specified alarm severity.
Parameters
severity:AlarmSeverity (default = null ) — the alarm severity to be counted
|
int — the total new alarm count for the connected element box and
the specified alarm severity.
|
getTotalAlarmCount | () | method |
public function getTotalAlarmCount(severity:AlarmSeverity = null):int
Get total alarm count for specified alarm severity. This will include new alarms and acknowledged alarms.
Parameters
severity:AlarmSeverity (default = null ) — the alarm severity need to count.
|
int — total alarm count for specified alarm severity. This will include
new alarms and acknowledged alarms.
|
removePropertyChangeListener | () | method |
public function removePropertyChangeListener(listener:Function):void
Remove the specified property change listener from this class.
Parameters
listener:Function — the listener need to be removed.
|
reset | () | method |
public function reset():void
Call this to reset all numbers to zero.