XTCE12 — inside/outside alarms not supported

Description Kevin Rice 2008-05-30 19:32:10 BST
most organization use some outside alarms, not available now

Allow for the case of inner/outer alarm range definition

Proposal is to update the alarm ranges to permit the user to specify whether or not alarms are in "inner" or "outer" form.

Add the following types (new) to the types section:

<simpleType name="RangeFormType">
<annotation>
<documentation>Defines whether the defined range between the minimum and maximum is the outside or inside the range being defined. The default, outside matches values less than the minimum and greater than the maximum. Inside matches values between the minimum and maximum.</documentation>
</annotation>
<restriction base="string">
<enumeration value="outside"/>
<enumeration value="inside"/>
</restriction>
</simpleType>

<complexType name="BaseAlarmType" abstract="true">
<annotation>
<documentation>Supplies an optional non-reference-able name and short description for alarms. Also includes an optional ancillary data for any special local flags, note that these may not necessarily transfer to another recipient of an instance document.</documentation>
</annotation>
<sequence>
<element name="AncillaryDataSet" type="xtce:AncillaryDataSetType" minOccurs="0"/>
</sequence>
<attribute name="name" type="string"/>
<attribute name="shortDescription" type="xtce:ShortDescriptionType"/>
</complexType>

Replace the AlarmRangesType definition with the definition below. This adds the @rangeForm attribute to the AlarmRangesType, makes it extend BaseAlarmType and provides new documentation for the inside/outside settings:

<complexType name="AlarmRangesType">
<annotation>
<documentation>Describe up to six ranges where either less severe ranges are a subset of more severe ranges (outside), or more severe ranges are a subset of less severe ranges (inside). In both forms, the undefined least severe range is normal. Range values are in calibrated engineering units. See FloatRangeType.</documentation>
</annotation>
<complexContent>
<extension base="xtce:BaseAlarmType">
<sequence>
<element name="WatchRange" type="xtce:FloatRangeType" minOccurs="0"/>
<element name="WarningRange" type="xtce:FloatRangeType" minOccurs="0"/>
<element name="DistressRange" type="xtce:FloatRangeType" minOccurs="0"/>
<element name="CriticalRange" type="xtce:FloatRangeType" minOccurs="0"/>
<element name="SevereRange" type="xtce:FloatRangeType" minOccurs="0"/>
</sequence>
<attribute name="rangeForm" type="xtce:RangeFormType" default="outside">
<annotation>
<documentation>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</documentation>
</annotation>
</attribute>
</extension>
</complexContent>
</complexType>