AlarmRanges (Yamcs :: XTCE 5.4.2 API)

java.lang.Object
- org.yamcs.xtce.AlarmRanges

All Implemented Interfaces:

Serializable
```
public class AlarmRanges
extends Object
implements Serializable
```
Contains five ranges: Watch, Warning, Distress, Critical, and Severe each in increasing severity. Normally, only the Warning and Critical ranges are used and the color yellow is associated with Warning and the color red is associated with Critical. The ranges given are valid for numbers lower than the min and higher than the max values. These ranges should not overlap, but if they do, assume the most severe range is to be applied. All ranges are optional and it is quite allowed for there to be only one end of the range. Range values are in calibrated engineering units. Note that we actually keep here the ranges for the IN_LIMITS. This means that if range.inRange(v)!=0 (meaning v out of range), then the parameter is in alarm state.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AlarmRanges()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCriticalRange(DoubleRange range)`
`void`	`addDistressRange(DoubleRange range)`
`void`	`addRange(DoubleRange range, AlarmLevels level)`
`void`	`addSevereRange(DoubleRange range)`
`void`	`addWarningRange(DoubleRange range)`
`void`	`addWatchRange(DoubleRange range)`
`DoubleRange`	`getCriticalRange()`
`DoubleRange`	`getDistressRange()`
`DoubleRange`	`getSevereRange()`
`DoubleRange`	`getWarningRange()`
`DoubleRange`	`getWatchRange()`
`void`	`setWarningRange(DoubleRange warningRange)`
`String`	`toString()`

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

Constructor Detail
- AlarmRanges
```
public AlarmRanges()
```

Method Detail

addWatchRange

public void addWatchRange(DoubleRange range)

addWarningRange

public void addWarningRange(DoubleRange range)

addDistressRange

public void addDistressRange(DoubleRange range)

addCriticalRange

public void addCriticalRange(DoubleRange range)

addSevereRange

public void addSevereRange(DoubleRange range)

addRange

public void addRange(DoubleRange range,
                     AlarmLevels level)

getWatchRange
```
public DoubleRange getWatchRange()
```

getWarningRange
```
public DoubleRange getWarningRange()
```

getDistressRange
```
public DoubleRange getDistressRange()
```

getCriticalRange
```
public DoubleRange getCriticalRange()
```

getSevereRange
```
public DoubleRange getSevereRange()
```

setWarningRange

public void setWarningRange(DoubleRange warningRange)

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

toString in class Object