XTCE13 — Missing Alarm Disable Flag

I have seen a couple vendors now who have a possible flag for enabling/disabling alarm definitions on a per-parameter basis for individual alarms. Currently, XTCE does not have a mechanism for their databases to deliver the default enable/disable state.

Add an optional flag to indicate an enable/disable state from the factory for alarms

A database owner could deliver a flag for an alarm definition to be specified but disabled. This is a fairly simple addition to the XTCE AlarmType schema type.

While looking at this, it was also noticed that the minConformance attribute should have had a default value of 1, since it is optional and the minViolations attribute also have a default.

Propose to update the AlarmType definition from:

<complexType name="AlarmType" abstract="true">
<annotation>
<documentation xml:lang="en">Defines a base schema type used to build up the other data type specific alarm types. The definition includes a count to go into alarm (minViolations - the counts to go out of alarm is the same), a condition style alarm and a custom alarm. See AlarmConditionType, CustomAlgorithmType, BinaryAlarmConditionType, BooleanAlarmType, BinaryContextAlarmType, EnumerationAlarmType, NumericAlarmType, StringAlarmType, TimeAlarmType, TimeAlarmConditionType.</documentation>
</annotation>
<complexContent>
<extension base="xtce:BaseAlarmType">
<choice>
<element name="AlarmConditions" type="xtce:AlarmConditionsType">
<annotation>
<documentation xml:lang="en">A MatchCriteria may be specified for each of the 5 alarm levels. Each level is optional and the alarm should be the highest level to test true.</documentation>
</annotation>
</element>
<element name="CustomAlarm" type="xtce:CustomAlarmType">
<annotation>
<documentation xml:lang="en">An escape for ridiculously complex alarm conditions. Will trigger on changes to the containing Parameter.</documentation>
</annotation>
</element>
</choice>
<attribute name="minViolations" type="xtce:PositiveLongType" default="1">
<annotation>
<documentation xml:lang="en">The number of successive instances that meet the alarm conditions for the alarm to trigger. The default is 1.</documentation>
</annotation>
</attribute>
<attribute name="minConformance" type="xtce:PositiveLongType">
<annotation>
<documentation xml:lang="en">Optionally specify the number of successive instances that do not meet the alarm conditions to leave the alarm state. If this attribute is not specified, it is treated as being equal to minViolations (symmetric).</documentation>
</annotation>
</attribute>
</extension>
</complexContent>
</complexType>

With the following replacement that adds 1 attribute named "disabled" with a default value of "false". Also adds the default value of 1 to the minConformance attribute:

<complexType name="AlarmType" abstract="true">
<annotation>
<documentation xml:lang="en">Defines a base schema type used to build up the other data type specific alarm types. The definition includes a count to go into alarm (minViolations - the counts to go out of alarm is the same), a condition style alarm and a custom alarm. See AlarmConditionType, CustomAlgorithmType, BinaryAlarmConditionType, BooleanAlarmType, BinaryContextAlarmType, EnumerationAlarmType, NumericAlarmType, StringAlarmType, TimeAlarmType, TimeAlarmConditionType.</documentation>
</annotation>
<complexContent>
<extension base="xtce:BaseAlarmType">
<choice>
<element name="AlarmConditions" type="xtce:AlarmConditionsType">
<annotation>
<documentation xml:lang="en">A MatchCriteria may be specified for each of the 5 alarm levels. Each level is optional and the alarm should be the highest level to test true.</documentation>
</annotation>
</element>
<element name="CustomAlarm" type="xtce:CustomAlarmType">
<annotation>
<documentation xml:lang="en">An escape for ridiculously complex alarm conditions. Will trigger on changes to the containing Parameter.</documentation>
</annotation>
</element>
</choice>
<attribute name="minViolations" type="xtce:PositiveLongType" default="1">
<annotation>
<documentation xml:lang="en">The number of successive instances that meet the alarm conditions for the alarm to trigger. The default is 1.</documentation>
</annotation>
</attribute>
<attribute name="minConformance" type="xtce:PositiveLongType" default="1">
<annotation>
<documentation xml:lang="en">Optionally specify the number of successive instances that do not meet the alarm conditions to leave the alarm state. If this attribute is not specified, it is treated as being equal to minViolations (symmetric).</documentation>
</annotation>
</attribute>
<attribute name="disabled" type="boolean" default="false">
<annotation>
<documentation xml:lang="en">The initial state of this alarm definition as delivered. When true, this leaves the alarm definition empty for the parameter and also short circuits the remaining context matches and the default so no alarm is active on the parameter.</documentation>
</annotation>
</attribute>
</extension>
</complexContent>
</complexType>

A diagram showing the alarm evaluation behavior is provided for reviewer reference.