XTCE12 — Consolidate the proposals for ParameterProperties element

The ParameterProperties element has gone down two different paths during the XTCE 1.2 evolution discussions. The results of that have not been captured in the balloted schema.

Propose to merge the proposals for ParameterProperties

There were two different paths proposed for ParameterProperties. One path was to remove the element. The other path made small enhancements. Propose to adopt the changes in a backwards compatible way.

This means to retain the ParameterProperties element and update the documentation to be more clear. Also, a new proposed attribute named "persistence" is added.

Replace the existing complexType definition in the schema:

<complexType name="ParameterPropertiesType" mixed="false">
<annotation>
<documentation xml:lang="en">A wrapper for those properties that are unique to telemetry parameters.</documentation>
</annotation>
<sequence>
<element name="SystemName" type="string" minOccurs="0">
<annotation>
<documentation xml:lang="en">Optional. Normally used when the database is built in a flat, non-hierarchical format</documentation>
</annotation>
</element>
<element name="ValidityCondition" type="xtce:MatchCriteriaType" minOccurs="0">
<annotation>
<documentation xml:lang="en">Optional condition that must be true for this Parameter to be valid</documentation>
</annotation>
</element>
<element name="PhysicalAddressSet" type="xtce:PhysicalAddressSetType" minOccurs="0"/>
<element name="TimeAssociation" type="xtce:TimeAssociationType" minOccurs="0">
<annotation>
<documentation xml:lang="en">This time will override any Default value for TimeAssociation. </documentation>
</annotation>
</element>
</sequence>
<attribute name="dataSource" type="xtce:TelemetryDataSourceType" use="optional"/>
<attribute name="readOnly" type="boolean" use="optional" default="false">
<annotation>
<documentation xml:lang="en">A Parameter marked as 'readOnly' true is constant and non-settable</documentation>
</annotation>
</attribute>
</complexType>

With this new definition of the type:

<complexType name="ParameterPropertiesType" mixed="false">
<annotation>
<documentation xml:lang="en">Describes extended properties/attributes of Parameter definitions.</documentation>
</annotation>
<sequence>
<element name="SystemName" type="string" minOccurs="0">
<annotation>
<documentation xml:lang="en">Optional. Normally used when the database is built in a flat, non-hierarchical format.</documentation>
</annotation>
</element>
<element name="ValidityCondition" type="xtce:MatchCriteriaType" minOccurs="0">
<annotation>
<documentation xml:lang="en">Optional condition that must be true for this Parameter to be valid.</documentation>
</annotation>
</element>
<element name="PhysicalAddressSet" type="xtce:PhysicalAddressSetType" minOccurs="0">
<annotation>
<documentation xml:lang="en">When present, this set of elements describes physical address location(s) of the parameter where it is stored. Typically this is on the data source, although that is not constrained by this schema.</documentation>
</annotation>
</element>
<element name="TimeAssociation" type="xtce:TimeAssociationType" minOccurs="0">
<annotation>
<documentation xml:lang="en">This time will override any Default value for TimeAssociation.</documentation>
</annotation>
</element>
</sequence>
<attribute name="dataSource" type="xtce:TelemetryDataSourceType" use="optional">
<annotation>
<documentation xml:lang="en">This attribute describes the nature of the source entity for which this parameter receives a value. Implementations assign different attributes/properties internally to a parameter based on the anticipated data source.</documentation>
</annotation>
</attribute>
<attribute name="readOnly" type="boolean" use="optional" default="false">
<annotation>
<documentation xml:lang="en">A Parameter marked as 'readOnly' true is constant and non-settable. Note that a slight conceptual overlap exists here between the 'dataSource' and this attribute. When the 'dataSource' is 'constant', then 'readOnly' should be 'true'. Application implementations may choose to implicitly enforce this. Some implementations have both concepts of a Parameter that is settable and a Constant in a different part of the data model.</documentation>
</annotation>
</attribute>
<attribute name="persistence" type="boolean" default="true">
<annotation>
<documentation xml:lang="en">A Parameter marked to persist should retain the latest value through resets/restarts to the extent that is possible or defined in the implementation. The net effect is that the initial/default value on a Parameter is only seen once or when the system has a reset to revert to initial/default values.</documentation>
</annotation>
</attribute>
</complexType>