XTCE13 — Clarify Behavior of Context Alarms Only Containing a Match

It is unclear in the documentation how it should be handled when a parameter defines a context alarm for which only a match element is provided. This is valid in the schema.

Add additional ContextMatch annotations

To make this scenario more clear to the users, we propose to add the following additional annotation.

Existing ContextMatchType:

<complexType name="ContextMatchType">
<annotation>
<documentation xml:lang="en">A MatchCriteriaType used for Context selection.</documentation>
</annotation>
<complexContent>
<extension base="xtce:MatchCriteriaType"/>
</complexContent>
</complexType>

New ContextMatchType:

<complexType name="ContextMatchType">
<annotation>
<documentation xml:lang="en">A MatchCriteriaType used for Context selection. It is possible that no match evaluates to true, which results in the default element being used. It is also possible that a match can have an empty context change, in which case the default is replaced with nothing.</documentation>
</annotation>
<complexContent>
<extension base="xtce:MatchCriteriaType"/>
</complexContent>
</complexType>

Existing BinaryContextAlarmListType:

<complexType name="BinaryContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context binary alarms, duplicates are valid. Process the contexts in list order. See BinaryContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:BinaryContextAlarmType" maxOccurs="unbounded"/>
</sequence>
</complexType>

New BinaryContextAlarmListType:

<complexType name="BinaryContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context binary alarms, duplicates are valid. Process the contexts in list order. See BinaryContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:BinaryContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing BooleanContextAlarmListType:

<complexType name="BooleanContextAlarmListType">
<sequence>
<element name="ContextAlarm" type="xtce:BooleanContextAlarmType" maxOccurs="unbounded"/>
</sequence>
</complexType>

New BooleanContextAlarmListType:

<complexType name="BooleanContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context boolean alarms, duplicates are valid. Process the contexts in list order. See BooleanContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:BooleanContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing EnumerationContextAlarmListType:

<complexType name="EnumerationContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context enumeration alarms, duplicates are valid. Process the contexts in list order. See EnumerationContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:EnumerationContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">Describe the alarm matching context criteria and the alarm definition itself.</documentation>
</annotation>
</element>
</sequence>
</complexType>

New EnumerationContextAlarmListType:

<complexType name="EnumerationContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context enumeration alarms, duplicates are valid. Process the contexts in list order. See EnumerationContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:EnumerationContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing StringContextAlarmListType:

<complexType name="StringContextAlarmListType">
<annotation>
<documentation xml:lang="en">An ordered collection of numeric alarms associated with a context. Process the contexts in list order. See StringContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:StringContextAlarmType" maxOccurs="unbounded"/>
</sequence>
</complexType>

New StringContextAlarmListType:

<complexType name="StringContextAlarmListType">
<annotation>
<documentation xml:lang="en">Describe an ordered collection of context string alarms, duplicates are valid. Process the contexts in list order. See StringContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:StringContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing NumericContextAlarmListType:

<complexType name="NumericContextAlarmListType">
<annotation>
<documentation xml:lang="en">An ordered collection of numeric alarms associated with a context. A context is an alarm definition on a parameter which is valid only in the case of a test on the value of other parameters. Process the contexts in list order. Used by both FloatParameterType and IntegerParameterType. See NumericContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:NumericContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A contextual alarm definition for the parameter that uses this type that is valid when a test against the value of one or more other parameters evaluates to true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

New NumericContextAlarmListType:

<complexType name="NumericContextAlarmListType">
<annotation>
<documentation xml:lang="en">An ordered collection of numeric alarms associated with a context. A context is an alarm definition on a parameter which is valid only in the case of a test on the value of other parameters. Process the contexts in list order. Used by both FloatParameterType and IntegerParameterType. See NumericContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:NumericContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing TimeContextAlarmListType:

<complexType name="TimeContextAlarmListType">
<sequence>
<element name="ContextAlarm" type="xtce:TimeContextAlarmType" maxOccurs="unbounded"/>
</sequence>
</complexType>

New TimeContextAlarmListType:

<complexType name="TimeContextAlarmListType">
<annotation>
<documentation xml:lang="en">An ordered collection of temporal alarms associated with a context. A context is an alarm definition on a parameter which is valid only in the case of a test on the value of other parameters. Process the contexts in list order. See TimeContextAlarmType.</documentation>
</annotation>
<sequence>
<element name="ContextAlarm" type="xtce:TimeContextAlarmType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a new alarm definition and a context match. The match takes precedence over any default alarm when the first in the overall list evaluates to true. It is also possible the alarm definition is empty, in which case the context means no alarm defined when the match is true.</documentation>
</annotation>
</element>
</sequence>
</complexType>

Existing ContextSignificanceListType:

<complexType name="ContextSignificanceListType">
<annotation>
<documentation xml:lang="en">Describe an ordered list of ContextSignificance elements where the significance on the first context match to test true is used as the significance of the MetaCommand. If there is a DefaultSignificance, it is overrideen by the matching context. See ContextSignificantType and MetaCommandType.</documentation>
</annotation>
<sequence>
<element name="ContextSignificance" type="xtce:ContextSignificanceType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">Describe a significance level for a MetaCommand definition where the significance level depends on matching a context value. See ContextMatchType and SignificanceType.</documentation>
</annotation>
</element>
</sequence>
</complexType>

New ContextSignificanceListType:

<complexType name="ContextSignificanceListType">
<annotation>
<documentation xml:lang="en">Describe an ordered list of ContextSignificance elements where the significance on the first context match to test true is used as the significance of the MetaCommand. If there is a DefaultSignificance, it is overrideen by the matching context. See ContextSignificantType and MetaCommandType.</documentation>
</annotation>
<sequence>
<element name="ContextSignificance" type="xtce:ContextSignificanceType" maxOccurs="unbounded">
<annotation>
<documentation xml:lang="en">A Context contains a different significance definition and a context match. The match takes precedence over any default significance when the first in the overall list evaluates to true.</documentation>
</annotation>
</element>
</sequence>
</complexType>