mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 132
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Sat 2011-04-30 18:47:17 -0500
message:
  Working on Element documentation strings. Completed structures.xsd Bug #771266
modified:
  schemas/structures.xsd


--
lp:mlhim-specs
https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main

Your team MLHIM Specifications Developers is subscribed to branch lp:mlhim-specs.
To unsubscribe from this branch go to https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main/+edit-subscription

=== modified file 'schemas/structures.xsd'
--- schemas/structures.xsd	2011-04-30 21:22:48 +0000
+++ schemas/structures.xsd	2011-04-30 23:47:17 +0000
@@ -38,15 +38,15 @@
              <xs:sequence>
               
                <xs:element name="time" maxOccurs="1" minOccurs="1" type="mlhim2:DvDateTime">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Time of this event. If the width is non-zero, it is the time point of the trailing edge of the event.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="data" maxOccurs="1" minOccurs="1" type="mlhim2:DvAny">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>The data of this event.</xs:documentation></xs:annotation>
                </xs:element>
               
-               <xs:element name="details" maxOccurs="1" minOccurs="1" type="mlhim2:ItemStructure">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:element name="state" maxOccurs="1" minOccurs="1" type="mlhim2:ItemStructure">
+	    <xs:annotation><xs:documentation>Optional state data for this event.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -76,15 +76,15 @@
              <xs:sequence>
               
                <xs:element name="width" maxOccurs="1" minOccurs="1" type="mlhim2:DvInterval">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Length of the interval during which the state was true.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="math_function" maxOccurs="1" minOccurs="1" type="mlhim2:DvCodedText">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Mathematical function of the data of this event, e.g. “maximum”, “mean” etc. Coded  using MLHIM Terminology group “event  math function”.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="sample_count" maxOccurs="1" minOccurs="1" type="xs:integer">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Optional count of original samples to which this event corresponds.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -115,11 +115,11 @@
              <xs:sequence>
               
                <xs:element name="ccd" maxOccurs="1" minOccurs="1" type="xs:string">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>The CCD ID selelcted at run-time.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="allowed_ccds" maxOccurs="unbounded" minOccurs="1" type="xs:string">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>A list of allowed CCD IDs of which one is selelcted at runtime.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -137,7 +137,7 @@
              <xs:sequence>
               
                <xs:element name="dv" maxOccurs="1" minOccurs="1" type="mlhim2:DvAny">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>data value of this leaf</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -155,7 +155,7 @@
              <xs:sequence>
               
                <xs:element name="items" maxOccurs="unbounded" minOccurs="1" type="mlhim2:Item">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>List of Items.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -175,23 +175,23 @@
              <xs:sequence>
               
                <xs:element name="origin" maxOccurs="1" minOccurs="1" type="mlhim2:DvDateTime">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Time origin of this event history. The first event is not necessarily at the origin point.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="events" maxOccurs="unbounded" minOccurs="1" type="mlhim2:Event">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>The events in the series.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="period" maxOccurs="1" minOccurs="1" type="mlhim2:DvDuration">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Period between samples in this segment if periodic.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="duration" maxOccurs="1" minOccurs="1" type="mlhim2:DvDuration">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="summary" maxOccurs="1" minOccurs="1" type="mlhim2:ItemStructure">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Optional summary data expressing e.g. text or image which summarises entire History.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -210,7 +210,7 @@
              <xs:sequence>
               
                <xs:element name="item" maxOccurs="1" minOccurs="0" type="mlhim2:Element">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>Element, Cluster or Slot for this Item.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -229,7 +229,7 @@
              <xs:sequence>
               
                <xs:element name="items" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Element">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>List of Elements, Clusters or Slots for this Item.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -251,7 +251,7 @@
              <xs:sequence>
               
                <xs:element name="rows" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Cluster">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+	    <xs:annotation><xs:documentation>List of Clusters for this Item.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>
@@ -270,8 +270,8 @@
            <xs:extension  base="mlhim2:ItemStructure">
              <xs:sequence>
               
-               <xs:element name="items" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
-	    <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:element name="items" maxOccurs="unbounded" minOccurs="0" type="mlhim2:ItemStructure">
+	    <xs:annotation><xs:documentation>List of structures to define the root of the tree.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>          
            	</xs:extension>