XTCE12 — Add normal alarm condition or alarm ranges

Add a new alarm type to capture sequential ranges to permit a "barber pole" like definition. Reported by Kratos/ISI.

Propose to create a new AlarmMultiRanges definition in the numeric alarm types

The new alarm multi-range feature proposal permits users to define multiple alarm ranges in a sequence that goes beyond the more typical "inside" and "outside" range definitions. It can be thought of as a "barber pole" definition.

Adding support for the "multi-range" feature first requires adding two new complexType elements to the schema. These are:

<complexType name="MultiRangeType">
<annotation>
<documentation xml:lang="en">The alarm multi-range element type permits users to define multiple alarm ranges in a sequence that goes beyond the more typical "inside" and "outside" range definitions. It can be thought of as a "barber pole" definition.</documentation>
</annotation>
<complexContent>
<extension base="xtce:FloatRangeType">
<attribute name="rangeForm" type="xtce:RangeFormType" default="outside">
<annotation>
<documentation xml:lang="en">A value of outside specifies that the most severe range is outside all the other ranges: -severe -critical -distress -warning -watch normal +watch +warning +distress +critical +severe. A value of inside "inverts" these bands: -green -watch -warning -distress -critical severe +critical +distress +warning +watch. The most common form used is "outside" and is the default.</documentation>
</annotation>
</attribute>
<attribute name="level" type="xtce:ConcernLevelsType">
<annotation>
<documentation xml:lang="en">The level of concern for this alarm definition.</documentation>
</annotation>
</attribute>
</extension>
</complexContent>
</complexType>

and:

<complexType name="AlarmMultiRangesType">
<annotation>
<documentation xml:lang="en">Describe any number of alarm ranges, each with its own level (normal, warning, watch, distress, critical, severe) and range form (inside or outside). Ranges may overlap, be disjoint and so forth. Ranges within the value sprectrum non-specified are non-normal. The most severe range level of value within the ranges is the level of the alarm. Range values are in calibrated engineering units. See FloatRangeType.</documentation>
</annotation>
<complexContent>
<extension base="xtce:BaseAlarmType">
<sequence>
<element name="Range" type="xtce:MultiRangeType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">Describe any number of alarm ranges, each with its own level (normal, warning, watch, distress, critical, severe) and range form (inside or outside). Ranges may overlap, be disjoint and so forth. Ranges within the value sprectrum non-specified are non-normal. The most severe range level of value within the ranges is the level of the alarm. Range values are in calibrated engineering units. See FloatRangeType.</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>

These two new types are utilized by adding a new element to the complexType NumericAlarmType. This new element definition in the XSD appears after the two existing element definitions and is named AlarmMultiRanges. The updated definition is:

<complexType name="NumericAlarmType">
<annotation>
<documentation xml:lang="en">Describe alarm conditions specific to the numeric data types, extends the basic AlarmType with StaticAlarmRanges and ChangeAlarmRanges. See FloatParameterType and IntegerParameterType.</documentation>
</annotation>
<complexContent>
<extension base="xtce:AlarmType">
<sequence>
<element name="StaticAlarmRanges" type="xtce:AlarmRangesType" minOccurs="0">
<annotation>
<documentation xml:lang="en">StaticAlarmRanges are used to trigger alarms when the parameter value passes some threshold value.</documentation>
</annotation>
</element>
<element name="ChangeAlarmRanges" type="xtce:ChangeAlarmRangesType" minOccurs="0">
<annotation>
<documentation xml:lang="en">ChangeAlarmRanges are used to trigger alarms when the parameter value changes by a rate or quantity from a reference.</documentation>
</annotation>
</element>
<element name="AlarmMultiRanges" type="xtce:AlarmMultiRangesType" minOccurs="0">
<annotation>
<documentation xml:lang="en">Similar to but more lenient form of StaticAlarmRanges.</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>