Class BasicAlarmStateSummary
- java.lang.Object
 - 
- com.inductiveautomation.ignition.gateway.alarming.evaluation.BasicAlarmStateSummary
 
 
- 
- All Implemented Interfaces:
 AlarmStateSummary
public class BasicAlarmStateSummary extends java.lang.Object implements AlarmStateSummary
 
- 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)static AlarmStateSummaryfromEvents(java.util.List<AlarmEvent> events, AlarmEvalState evalState)static AlarmStateSummaryfromStates(java.util.List<AlarmStateSummary> states)intgetActiveAcked()intgetActiveUnacked()intgetClearedUnacked()AlarmEvalStategetEvaluationStatus()AlarmPrioritygetHighestAcked()java.lang.StringgetHighestAckedName()java.lang.StringgetHighestActiveName()Returns the highest active alarm, either acknowledged or not.AlarmPrioritygetHighestActivePriority()AlarmPrioritygetHighestUnacked()java.lang.StringgetHighestUnackedName()java.lang.LonggetMostRecentActiveTime()intgetShelvedCount()booleanhasActive()inthashCode()booleanhasUnacknowledged()voidsetActiveAcked(int activeAcked)voidsetActiveUnacked(int activeUnacked)voidsetClearedUnacked(int clearedUnacked)voidsetHighestAcked(AlarmPriority highestAcked)voidsetHighestAckedName(java.lang.String highestAckedName)voidsetHighestUnacked(AlarmPriority highestUnacked)voidsetHighestUnackedName(java.lang.String highestUnackedName)voidsetShelvedCount(int shelvedCount)voidupdateHighestAcked(java.lang.String name, AlarmPriority prio)voidupdateHighestUnacked(java.lang.String name, AlarmPriority prio) 
 - 
 
- 
- 
Method Detail
- 
fromStates
public static AlarmStateSummary fromStates(java.util.List<AlarmStateSummary> states)
 
- 
fromEvents
public static AlarmStateSummary fromEvents(java.util.List<AlarmEvent> events, AlarmEvalState evalState)
 
- 
getEvaluationStatus
public AlarmEvalState getEvaluationStatus()
- Specified by:
 getEvaluationStatusin interfaceAlarmStateSummary
 
- 
getMostRecentActiveTime
public java.lang.Long getMostRecentActiveTime()
- Specified by:
 getMostRecentActiveTimein interfaceAlarmStateSummary
 
- 
getActiveUnacked
public int getActiveUnacked()
- Specified by:
 getActiveUnackedin interfaceAlarmStateSummary
 
- 
setActiveUnacked
public void setActiveUnacked(int activeUnacked)
 
- 
getActiveAcked
public int getActiveAcked()
- Specified by:
 getActiveAckedin interfaceAlarmStateSummary
 
- 
setActiveAcked
public void setActiveAcked(int activeAcked)
 
- 
getShelvedCount
public int getShelvedCount()
- Specified by:
 getShelvedCountin interfaceAlarmStateSummary
 
- 
setShelvedCount
public void setShelvedCount(int shelvedCount)
 
- 
hasActive
public boolean hasActive()
- Specified by:
 hasActivein interfaceAlarmStateSummary
 
- 
hasUnacknowledged
public boolean hasUnacknowledged()
- Specified by:
 hasUnacknowledgedin interfaceAlarmStateSummary
 
- 
getClearedUnacked
public int getClearedUnacked()
- Specified by:
 getClearedUnackedin interfaceAlarmStateSummary
 
- 
setClearedUnacked
public void setClearedUnacked(int clearedUnacked)
 
- 
getHighestUnacked
public AlarmPriority getHighestUnacked()
- Specified by:
 getHighestUnackedin interfaceAlarmStateSummary
 
- 
setHighestUnacked
public void setHighestUnacked(AlarmPriority highestUnacked)
 
- 
getHighestAcked
public AlarmPriority getHighestAcked()
- Specified by:
 getHighestAckedin interfaceAlarmStateSummary
 
- 
setHighestAcked
public void setHighestAcked(AlarmPriority highestAcked)
 
- 
getHighestUnackedName
public java.lang.String getHighestUnackedName()
- Specified by:
 getHighestUnackedNamein interfaceAlarmStateSummary
 
- 
setHighestUnackedName
public void setHighestUnackedName(java.lang.String highestUnackedName)
 
- 
getHighestAckedName
public java.lang.String getHighestAckedName()
- Specified by:
 getHighestAckedNamein interfaceAlarmStateSummary
 
- 
setHighestAckedName
public void setHighestAckedName(java.lang.String highestAckedName)
 
- 
updateHighestAcked
public void updateHighestAcked(java.lang.String name, AlarmPriority prio) 
- 
updateHighestUnacked
public void updateHighestUnacked(java.lang.String name, AlarmPriority prio) 
- 
getHighestActiveName
public java.lang.String getHighestActiveName()
Description copied from interface:AlarmStateSummaryReturns the highest active alarm, either acknowledged or not.- Specified by:
 getHighestActiveNamein interfaceAlarmStateSummary
 
- 
getHighestActivePriority
public AlarmPriority getHighestActivePriority()
- Specified by:
 getHighestActivePriorityin interfaceAlarmStateSummary
 
- 
hashCode
public int hashCode()
- Overrides:
 hashCodein classjava.lang.Object
 
- 
equals
public boolean equals(java.lang.Object obj)
- Overrides:
 equalsin classjava.lang.Object
 
 - 
 
 -