Package org.yamcs.alarms

Class ActiveAlarm<T>

java.lang.Object
org.yamcs.alarms.ActiveAlarm<T>
public class ActiveAlarm<T> extends Object
Keeps track of the alarm for one parameter or event.

This will only exist for an alarm that has been triggered. A parameter that has limits definition but never had an out of limits value, will not have an active alarm.

Note: generics parameter T can effectively be either ParameterValue or Db.Event

  • Method Details

    • isAutoAcknowledge

      public boolean isAutoAcknowledge()

    • isAcknowledged

      public boolean isAcknowledged()

    • isPending

      public boolean isPending()

    • getId

      public int getId()

    • getAckMessage

      public String getAckMessage()

    • triggered

      public boolean triggered()

    • isShelved

      public boolean isShelved()

    • unshelve

      public void unshelve()

    • getShelveUsername

      public String getShelveUsername()

    • getShelveTime

      public long getShelveTime()

    • getShelveMessage

      public String getShelveMessage()

    • getShelveDuration

      public long getShelveDuration()

    • isNormal

      public boolean isNormal()
      Returns true if the alarm is back to normal: processOK=true, acknowledged=true and triggered=false

      Note that when latching is enabled, triggered can be true even if processOK=true

    • getShelveExpiration

      public long getShelveExpiration()

    • isProcessOK

      public boolean isProcessOK()

    • isTriggered

      public boolean isTriggered()

    • getClearTime

      public long getClearTime()

    • getUsernameThatShelved

      public String getUsernameThatShelved()

    • getClearMessage

      public String getClearMessage()

    • getUsernameThatCleared

      public String getUsernameThatCleared()

    • getUsernameThatAcknowledged

      public String getUsernameThatAcknowledged()

    • getAcknowledgeTime

      public long getAcknowledgeTime()

    • getTriggerValue

      public T getTriggerValue()

    • getCurrentValue

      public T getCurrentValue()

    • setCurrentValue

      public void setCurrentValue(T value)

    • getMostSevereValue

      public T getMostSevereValue()

    • incrementValueCount

      public void incrementValueCount()

    • getValueCount

      public int getValueCount()

    • setValueCount

      public void setValueCount(int valueCount)

    • incrementViolations

      public void incrementViolations()

    • getViolations

      public int getViolations()

    • setMostSevereValue

      public T setMostSevereValue(T mostSevereValue)

    • setPending

      public void setPending(boolean pending)

    • toString

      public String toString()
      Overrides:
      toString in class Object