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

Field Summary

Fields
Modifier and Type	Field	Description
`long`	`acknowledgeTime`
`String`	`clearMessage`
`long`	`clearTime`
`T`	`currentValue`
`T`	`mostSevereValue`
`T`	`triggerValue`
`String`	`usernameThatAcknowledged`
`String`	`usernameThatCleared`
`int`	`valueCount`
`int`	`violations`

Constructor Summary

Constructors
Constructor Description

ActiveAlarm(T pv)

ActiveAlarm(T pv, boolean autoAck, boolean latching)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`acknowledge(String username, long ackTime, String message)`	Acknowledge the alarm.
`void`	`clear(String username, long time, String message)`
`String`	`getAckMessage()`
`String`	`getClearMessage()`
`long`	`getClearTime()`
`int`	`getId()`
`long`	`getShelveDuration()`
`long`	`getShelveExpiration()`
`String`	`getShelveMessage()`
`long`	`getShelveTime()`
`String`	`getShelveUsername()`
`String`	`getUsernameThatCleared()`
`String`	`getUsernameThatShelved()`
`boolean`	`isAcknowledged()`
`boolean`	`isAutoAcknowledge()`
`boolean`	`isNormal()`
`boolean`	`isProcessOK()`
`boolean`	`isShelved()`
`boolean`	`isTriggered()`
`boolean`	`processRTN()`	Called when the process returns to normal (i.e. parameter is back in limits)
`void`	`reset()`	Called when the operator resets a latching alarm
`void`	`setAckMessage(String ackMessage)`
`void`	`setAcknowledged(boolean acknowledged)`
`void`	`setShelveDuration(long shelveDuration)`
`void`	`setShelveMessage(String shelveMessage)`
`void`	`setShelveTime(long shelveTime)`
`void`	`setUsernameThatShelved(String usernameThatShelved)`
`void`	`shelve(String username, String message, long shelveDuration)`
`String`	`toString()`
`void`	`trigger()`	Trigger the alarm if not already triggered
`boolean`	`triggered()`
`void`	`unshelve()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

acknowledgeTime
```
public long acknowledgeTime
```

clearTime
```
public long clearTime
```

triggerValue
```
public T triggerValue
```

mostSevereValue
```
public T mostSevereValue
```

currentValue
```
public T currentValue
```

clearMessage
```
public String clearMessage
```

violations
```
public int violations
```

valueCount
```
public int valueCount
```

usernameThatAcknowledged
```
public String usernameThatAcknowledged
```

usernameThatCleared
```
public String usernameThatCleared
```

Constructor Detail

ActiveAlarm

public ActiveAlarm(T pv,
                   boolean autoAck,
                   boolean latching)

ActiveAlarm
```
public ActiveAlarm(T pv)
```

Method Detail

isAutoAcknowledge
```
public boolean isAutoAcknowledge()
```

isAcknowledged
```
public boolean isAcknowledged()
```

setAcknowledged

public void setAcknowledged(boolean acknowledged)

getId
```
public int getId()
```

getAckMessage
```
public String getAckMessage()
```

setAckMessage

public void setAckMessage(String ackMessage)

triggered
```
public boolean triggered()
```

clear

public void clear(String username,
                  long time,
                  String message)

trigger
```
public void trigger()
```
Trigger the alarm if not already triggered

acknowledge

public void acknowledge(String username,
                        long ackTime,
                        String message)

Acknowledge the alarm. This method does nothing if the alarm is already acknowledged.

Parameters:: username -; ackTime -; message -

processRTN
```
public boolean processRTN()
```
Called when the process returns to normal (i.e. parameter is back in limits)

Returns:

true if the alarm has been updated

reset
```
public void reset()
```
Called when the operator resets a latching alarm

shelve

public void shelve(String username,
                   String message,
                   long shelveDuration)

isShelved
```
public boolean isShelved()
```

unshelve
```
public void unshelve()
```

getShelveUsername
```
public String getShelveUsername()
```

getShelveTime
```
public long getShelveTime()
```

setShelveTime

public void setShelveTime(long shelveTime)

getShelveMessage
```
public String getShelveMessage()
```

setShelveMessage

public void setShelveMessage(String shelveMessage)

getShelveDuration
```
public long getShelveDuration()
```

setShelveDuration

public void setShelveDuration(long shelveDuration)

isNormal
```
public boolean isNormal()
```

getShelveExpiration
```
public long getShelveExpiration()
```

isProcessOK
```
public boolean isProcessOK()
```

isTriggered
```
public boolean isTriggered()
```

getClearTime
```
public long getClearTime()
```

getClearMessage
```
public String getClearMessage()
```

getUsernameThatShelved

public String getUsernameThatShelved()

setUsernameThatShelved

public void setUsernameThatShelved(String usernameThatShelved)

getUsernameThatCleared

public String getUsernameThatCleared()

toString
```
public String toString()
```
Overrides:

toString in class Object

Constructor	Description
`ActiveAlarm(T pv)`
`ActiveAlarm(T pv, boolean autoAck, boolean latching)`

Class ActiveAlarm<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

acknowledgeTime

clearTime

triggerValue

mostSevereValue

currentValue

clearMessage

violations

valueCount

usernameThatAcknowledged

usernameThatCleared

Constructor Detail

ActiveAlarm

ActiveAlarm

Method Detail

isAutoAcknowledge

isAcknowledged

setAcknowledged

getId

getAckMessage

setAckMessage

triggered

clear

trigger

acknowledge

processRTN

reset

shelve

isShelved

unshelve

getShelveUsername

getShelveTime

setShelveTime

getShelveMessage

setShelveMessage

getShelveDuration

setShelveDuration

isNormal

getShelveExpiration

isProcessOK

isTriggered

getClearTime

getClearMessage

getUsernameThatShelved

setUsernameThatShelved

getUsernameThatCleared

toString