XTCE 1.2 RTF Avatar
  1. OMG Issue

XTCE12 — Enumeration element could use an @shortDescription

  • Key: XTCE12-8
  • Legacy Issue Number: 18540
  • Status: closed  
  • Source: Boeing ( Mr. David Overeem)
  • Summary:

    It would be convenient to add a shortDescription attribute to the Enumeration element for enumerated types.

  • Reported: XTCE 1.1 — Sun, 10 Mar 2013 05:00 GMT
  • Disposition: Resolved — XTCE 1.2
  • Disposition Summary:

    Allow for an optional @shortDescription in the Enumeration element

    Adding an optional @shortDescription to the Enumeration elements for parameter and argument types will satisfy some users. It is backwards compatible and can be easily ignored by uninterested parties. This attribute was inadvertently included in the proposed schema when the resolution for 12-136 was incorporated after ballot #6 was approved. If this resolution is not accepted the shortDescription attribute should be removed.

    The proposal is to add this attribute to the "ValueEnumerationType", which is applicable to both Parameter and Argument cases.

    <complexType name="ValueEnumerationType">
    <annotation>
    <documentation xml:lang="en">Contains a value and an associated string label. The value may be a range by specifying an upper maxValue range. If not a range, do not specify the maxValue.</documentation>
    </annotation>
    <attribute name="value" type="integer" use="required"/>
    <attribute name="maxValue" type="integer" use="optional"/>
    <attribute name="label" type="string" use="required"/>
    <attribute name="shortDescription" type="string" use="optional"/>
    </complexType>

  • Updated: Tue, 10 Jul 2018 14:22 GMT