Split out signature from metadata group, adjust all images

modelica · Nov 8, 2024 · 91536ae · 91536ae
1 parent f0f47d1
commit 91536ae
Show file tree

Hide file tree

Showing 36 changed files with 57 additions and 26 deletions.
diff --git a/docs/4___common_content.adoc b/docs/4___common_content.adoc
@@ -479,23 +479,21 @@ This attribute references another connector by name, that gives the size of this
 [#ssc_metadata]
 ==== MetaData Sequence
 
-image:images/SystemStructureCommon_GMetaData.png[image,width=597,height=196]
+image:images/SystemStructureCommon_GMetaData.png[image,width=690,height=197]
 
-The group GMetaData allows the specification of additional meta data and signatures for a given model element.
-Multiple (or no) MetaData and Signature elements may be present in a given model element.
+The group GMetaData allows the specification of additional meta data for a given model element.
+Multiple (or no) MetaData elements may be present in a given model element.
 
 [width="100%",cols="33%,67%",options="header",]
 |===
 |Element   |Description
 |MetaData  |One or more instances of this element *CAN* be present to specify meta data related to the containing model element.
 See below for details.
-|Signature |One or more instances of this element *CAN* be present to specify signatures related to the containing model element.
-See below for details.
 |===
 
 ===== MetaData
 
-image:images/SystemStructureCommon_MetaData.png[image,width=369,height=543]
+image:images/SystemStructureCommon_MetaData.png[image,width=462,height=479]
 
 This element specifies a source of meta data related to the containing model element.
 
@@ -541,16 +539,31 @@ The last option allows the specification of meta data sources that reside inside
 
 ===== Content
 
-image:images/SystemStructureCommon_Content.png[image,width=377,height=306]
+image:images/SystemStructureCommon_Content.png[image,width=372,height=191]
 
 This element specifies the inlined content of the model element meta data.
 
 When this element is present, its contents *MUST* be an `srmd:SimulationResourceMetaData` element as specified by the SRMD schema of the SSP Traceability Specification, if the type attribute of the enclosing MetaData element is `application/x-srmd-meta-data`, or any other valid XML content if the type attribute references another MIME type.
 In that case there *SHOULD* be a layered specification that defines how embedding the content works for that MIME type.
 
+[#ssc_signature]
+==== Signature Sequence
+
+image:images/SystemStructureCommon_GSignature.png[image,width=652,height=133]
+
+The group GSignautre allows the specification of digital signatures for a given model element.
+Multiple (or no) Signature elements may be present in a given model element.
+
+[width="100%",cols="33%,67%",options="header",]
+|===
+|Element   |Description
+|Signature |One or more instances of this element *CAN* be present to specify signatures related to the containing model element.
+See below for details.
+|===
+
 ===== Signature
 
-image:images/SystemStructureCommon_Signature.png[image,width=423,height=534]
+image:images/SystemStructureCommon_Signature.png[image,width=423,height=419]
 
 This element specifies digital signature information on the data or meta data referenced by the enclosing element:
 If the Signature element is contained within a MetaData element, it refers to the meta data referenced by the MetaData element.

diff --git a/docs/5___ssd.adoc b/docs/5___ssd.adoc
@@ -8,7 +8,7 @@ All SSD-specific elements live in the `http://ssp-standard.org/SSP1/SystemStruct
 
 === SystemStructureDescription
 
-image:images/image23.png[image,width=464,height=506]
+image:images/SystemStructureDescription_SystemStructureDescription.png[image,width=475,height=693]
 
 The root element of an SSD file *MUST* be a SystemStructureDescription element, which gives overall information about the system hierarchy described in this SSD file, including common meta-data, and acts as a bracket for the root system and its unit and enumeration definitions.
 
@@ -64,7 +64,7 @@ _This standard does not specify additional measures to deal with differing indep
 
 System, Component and SignalDictionaryReference XML elements are subtypes of a common TElement base type, that contains attributes and XML elements common to all kinds of model elements:
 
-image:images/image25.png[image,width=379,height=280]
+image:images/SystemStructureDescription_TElement.png[image,width=391,height=466]
 
 The following XML attributes are specified for the TElement type:
 
@@ -367,7 +367,7 @@ image:images/IconExample15.png[image,width=245,height=147]
 
 ==== ParameterBindings
 
-image:images/image32.png[image,width=646,height=470]
+image:images/SystemStructureDescription_ParameterBindings.png[image,width=746,height=719]
 
 The ParameterBindings element provides the parameter bindings for a component or system, where each binding is specified in a ParameterBinding element.
 A parameter binding applies a set of parameter values (a parameter set), supplied by a parameter source (for example a parameter file) to parametrize a component or system.
@@ -468,7 +468,7 @@ In that case there *SHOULD* be a layered specification that defines how embeddin
 
 ===== ParameterMapping
 
-image:images/image34.png[image,width=441,height=355]
+image:images/SystemStructureDescription_ParameterMapping.png[image,width=473,height=541]
 
 This element provides a parameter mapping, which specifies how the parameter names and values provided in the parameter source are to be mapped to the parameters of the component or system in question.
 If no mapping is supplied, the parameter names of the parameter source are used as is for name matching against the names of parameters in the component or system and the values of the parameter source are not transformed further before being applied.
@@ -499,7 +499,7 @@ In that case there *SHOULD* be a layered specification that defines how embeddin
 
 === System
 
-image:images/image35.png[image,width=452,height=641]
+image:images/SystemStructureDescription_System.png[image,width=463,height=827]
 
 This element describes a system, which can contain components, signal dictionary references and other systems as elements, connectors as an interface to the outside world, and connections connecting the connectors of itself and of its elements to one another.
 
@@ -687,7 +687,7 @@ image:images/image40.png[image,width=427,height=82]
 
 This optional element provides the set of defined signal dictionaries for the system.
 
-image:images/image41.png[image,width=415,height=336]
+image:images/SystemStructureDescription_SignalDictionary.png[image,width=447,height=522]
 
 A signal dictionary is a collection of signals which can be accessed in different systems at different levels of the hierarchy through signal dictionary references referencing the signal dictionary.
 
@@ -796,7 +796,7 @@ Inside the text attribute, newlines indicate paragraph breaks.
 
 === Component
 
-image:images/image45.png[image,width=470,height=588]
+image:images/SystemStructureDescription_Component.png[image,width=481,height=879]
 
 A component is an atomic element of a system (i.e. its internal structure is not specified).
 
@@ -840,7 +840,7 @@ It is an error if the specified type of FMU implementation is not present in the
 
 === SignalDictionaryReference
 
-image:images/image46.png[image,width=544,height=442]
+image:images/SystemStructureDescription_SignalDictionaryReference.png[image,width=555,height=733]
 
 A signal dictionary reference is an element of a system that references a signal dictionary, i.e. it is the place-holder of the signal dictionary that allows access to the contents of the signal dictionary through its connectors, which *MUST* reference signal dictionary entries.
 

diff --git a/docs/6___ssv.adoc b/docs/6___ssv.adoc
@@ -14,7 +14,7 @@ Except for this file extension recommendation the filename is arbitrary and is i
 
 === ParameterSet
 
-image:images/SystemStructureParameterValues_ParameterSet.png[image,width=405,height=574]
+image:images/SystemStructureParameterValues_ParameterSet.png[image,width=405,height=639]
 
 The ParameterSet element contains parameter and meta data information.
 If the SSV is provided as a separate file, the root element *MUST* be a ParameterSet element.

diff --git a/docs/7___ssm.adoc b/docs/7___ssm.adoc
@@ -17,7 +17,7 @@ The root element of an SSM file *MUST* be a ParameterMapping element, which cont
 
 === ParameterMapping
 
-image:images/SystemStructureParameterMapping_ParameterMapping.png[image,width=450,height=412]
+image:images/SystemStructureParameterMapping_ParameterMapping.png[image,width=450,height=477]
 
 This element describes a parameter mapping, which consists of multiple mapping entries, each describing one parameter mapping (see next section).
 The parameter mapping *MUST* contain entries for all parameters that are going to be mapped.

diff --git a/docs/8___ssb.adoc b/docs/8___ssb.adoc
@@ -16,7 +16,7 @@ Any enumerations or units used in the DictionaryEntry elements *MUST* be declare
 
 === SignalDictionary
 
-image:images/SystemStructureSignalDictionary_SignalDictionary.png[image,width=438,height=520]
+image:images/SystemStructureSignalDictionary_SignalDictionary.png[image,width=438,height=585]
 
 This element describes a signal dictionary, which consists of one or more dictionary entries, each describing one signal in the signal dictionary (see next section).
 

diff --git a/docs/images/SystemStructureCommon_Content.png b/docs/images/SystemStructureCommon_Content.png
diff --git a/docs/images/SystemStructureCommon_GMetaData.png b/docs/images/SystemStructureCommon_GMetaData.png
diff --git a/docs/images/SystemStructureCommon_GSignature.png b/docs/images/SystemStructureCommon_GSignature.png
diff --git a/docs/images/SystemStructureCommon_MetaData.png b/docs/images/SystemStructureCommon_MetaData.png
diff --git a/docs/images/SystemStructureCommon_Signature.png b/docs/images/SystemStructureCommon_Signature.png
diff --git a/docs/images/SystemStructureDescription_Component.png b/docs/images/SystemStructureDescription_Component.png
diff --git a/docs/images/SystemStructureDescription_ParameterBindings.png b/docs/images/SystemStructureDescription_ParameterBindings.png
diff --git a/docs/images/SystemStructureDescription_ParameterMapping.png b/docs/images/SystemStructureDescription_ParameterMapping.png
diff --git a/docs/images/SystemStructureDescription_SignalDictionary.png b/docs/images/SystemStructureDescription_SignalDictionary.png
diff --git a/docs/images/SystemStructureDescription_SignalDictionaryReference.png b/docs/images/SystemStructureDescription_SignalDictionaryReference.png
diff --git a/docs/images/SystemStructureDescription_System.png b/docs/images/SystemStructureDescription_System.png
diff --git a/docs/images/SystemStructureDescription_SystemStructureDescription.png b/docs/images/SystemStructureDescription_SystemStructureDescription.png
diff --git a/docs/images/SystemStructureDescription_TElement.png b/docs/images/SystemStructureDescription_TElement.png
diff --git a/docs/images/SystemStructureParameterMapping_ParameterMapping.png b/docs/images/SystemStructureParameterMapping_ParameterMapping.png
diff --git a/docs/images/SystemStructureParameterValues_ParameterSet.png b/docs/images/SystemStructureParameterValues_ParameterSet.png
diff --git a/docs/images/SystemStructureSignalDictionary_SignalDictionary.png b/docs/images/SystemStructureSignalDictionary_SignalDictionary.png
diff --git a/docs/images/image23.png b/docs/images/image23.png
diff --git a/docs/images/image25.png b/docs/images/image25.png
diff --git a/docs/images/image30.png b/docs/images/image30.png
diff --git a/docs/images/image32.png b/docs/images/image32.png
diff --git a/docs/images/image34.png b/docs/images/image34.png
diff --git a/docs/images/image35.png b/docs/images/image35.png
diff --git a/docs/images/image41.png b/docs/images/image41.png
diff --git a/docs/images/image45.png b/docs/images/image45.png
diff --git a/docs/images/image46.png b/docs/images/image46.png
diff --git a/schema/SystemStructureCommon.xsd b/schema/SystemStructureCommon.xsd
@@ -274,15 +274,15 @@
                                 </xs:documentation>
                             </xs:annotation>
                         </xs:element>
-                        <xs:element name="Signature" type="ssc:SignatureType" minOccurs="0" maxOccurs="unbounded">
+                        <xs:group ref="ssc:GSignature">
                             <xs:annotation>
                                 <xs:documentation xml:lang="en">
                                     This element can contain digital signature information on the meta data referenced
                                     by the enclosing MetaData element. It is left unspecified what types of signatures
                                     are used and/or available for now.  Multiple or no signature elements may be present.
                                 </xs:documentation>
                             </xs:annotation>
-                        </xs:element>
+                        </xs:group>
                     </xs:sequence>
                     <xs:attribute name="kind" use="required">
                         <xs:annotation>
@@ -343,6 +343,11 @@
                     <xs:attributeGroup ref="ssc:ABaseElement"/>
                 </xs:complexType>
             </xs:element>
+        </xs:sequence>
+    </xs:group>
+
+    <xs:group name="GSignature">
+        <xs:sequence>
             <xs:element name="Signature" type="ssc:SignatureType" minOccurs="0" maxOccurs="unbounded">
                 <xs:annotation>
                     <xs:documentation xml:lang="en">
@@ -354,7 +359,7 @@
             </xs:element>
         </xs:sequence>
     </xs:group>
-
+    
     <xs:complexType name="SignatureType">
         <xs:sequence>
             <xs:element name="Content" type="ssc:ContentType" minOccurs="0" maxOccurs="1"/>

diff --git a/schema/SystemStructureDescription.xsd b/schema/SystemStructureDescription.xsd
@@ -52,6 +52,7 @@
                 <xs:element name="Units" minOccurs="0" type="ssc:TUnits"/>
                 <xs:element name="DefaultExperiment" minOccurs="0" type="ssd:TDefaultExperiment"/>
                 <xs:group ref="ssc:GMetaData"/>
+                <xs:group ref="ssc:GSignature"/>
                 <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
             </xs:sequence>
             <xs:attribute name="version" use="required">
@@ -147,6 +148,7 @@
                 </xs:annotation>
             </xs:element>
             <xs:group ref="ssc:GMetaData"/>
+            <xs:group ref="ssc:GSignature"/>
         </xs:sequence>
         <xs:attributeGroup ref="ssc:ABaseElement"/>
         <xs:attribute name="name" use="required">
@@ -299,11 +301,12 @@
                             -->
                             <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
                         </xs:choice>
-                        <!-- NOTE: In XML Schema 1.1 this sequence would also contain the following entry:
+                        <!-- NOTE: In XML Schema 1.1 this sequence would also contain the following entries:
 
                              <xs:group ref="ssc:GMetaData"/>
+                             <xs:group ref="ssc:GSignature"/>
 
-                             which specifies the proper way to add meta data.
+                             which specifies the proper way to add meta data and signatures.
 
                              Due to restrictions in XML Schema 1.0, this would lead to a violation of the
                              unique particle attribution schema component constraint, since the MetaData
@@ -931,11 +934,12 @@
                                         -->
                                         <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
                                     </xs:choice>
-                                    <!-- NOTE: In XML Schema 1.1 this sequence would also contain the following entry:
+                                    <!-- NOTE: In XML Schema 1.1 this sequence would also contain the following entries:
 
                                          <xs:group ref="ssc:GMetaData"/>
+                                         <xs:group ref="ssc:GSignature"/>
 
-                                         which specifies the proper way to add meta data.
+                                         which specifies the proper way to add meta data and signatures.
 
                                          Due to restrictions in XML Schema 1.0, this would lead to a violation of the
                                          unique particle attribution schema component constraint, since the MetaData
@@ -982,6 +986,7 @@
                             </xs:complexType>
                         </xs:element>
                         <xs:group ref="ssc:GMetaData"/>
+                        <xs:group ref="ssc:GSignature"/>
                         <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
                     </xs:sequence>
                     <xs:attributeGroup ref="ssc:ABaseElement"/>

diff --git a/schema/SystemStructureDescription11.xsd b/schema/SystemStructureDescription11.xsd
@@ -61,6 +61,7 @@
                 <xs:element name="Units" minOccurs="0" type="ssc:TUnits"/>
                 <xs:element name="DefaultExperiment" minOccurs="0" type="ssd:TDefaultExperiment"/>
                 <xs:group ref="ssc:GMetaData"/>
+                <xs:group ref="ssc:GSignature"/>
                 <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
             </xs:sequence>
             <xs:attribute name="version" use="required">
@@ -156,6 +157,7 @@
                 </xs:annotation>
             </xs:element>
             <xs:group ref="ssc:GMetaData"/>
+            <xs:group ref="ssc:GSignature"/>
         </xs:sequence>
         <xs:attributeGroup ref="ssc:ABaseElement"/>
         <xs:attribute name="name" use="required">
@@ -297,6 +299,7 @@
                             <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
                         </xs:choice>
                         <xs:group ref="ssc:GMetaData"/>
+                        <xs:group ref="ssc:GSignature"/>
                     </xs:sequence>
                     <xs:attributeGroup ref="ssc:ABaseElement"/>
                     <xs:attribute name="type" type="xs:string" use="optional" default="application/x-ssp-signal-dictionary"/>
@@ -892,6 +895,7 @@
                                         <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
                                     </xs:choice>
                                     <xs:group ref="ssc:GMetaData"/>
+                                    <xs:group ref="ssc:GSignature"/>
                                 </xs:sequence>
                                 <xs:attributeGroup ref="ssc:ABaseElement"/>
                                 <xs:attribute name="type" type="xs:string" use="optional" default="application/x-ssp-parameter-mapping"/>
@@ -929,6 +933,7 @@
                             </xs:complexType>
                         </xs:element>
                         <xs:group ref="ssc:GMetaData"/>
+                        <xs:group ref="ssc:GSignature"/>
                         <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
                     </xs:sequence>
                     <xs:attributeGroup ref="ssc:ABaseElement"/>

diff --git a/schema/SystemStructureParameterMapping.xsd b/schema/SystemStructureParameterMapping.xsd
@@ -49,6 +49,7 @@
             <xs:sequence>
                 <xs:element name="MappingEntry" minOccurs="0" maxOccurs="unbounded" type="ssm:TMappingEntry"/>
                 <xs:group ref="ssc:GMetaData"/>
+                <xs:group ref="ssc:GSignature"/>
                 <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
             </xs:sequence>
             <xs:attribute name="version" use="required">

diff --git a/schema/SystemStructureParameterValues.xsd b/schema/SystemStructureParameterValues.xsd
@@ -51,6 +51,7 @@
                 <xs:element name="Enumerations" minOccurs="0" type="ssc:TEnumerations"/>
                 <xs:element name="Units" minOccurs="0" type="ssc:TUnits"/>
                 <xs:group ref="ssc:GMetaData"/>
+                <xs:group ref="ssc:GSignature"/>
                 <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
             </xs:sequence>
             <xs:attribute name="version" use="required">

diff --git a/schema/SystemStructureSignalDictionary.xsd b/schema/SystemStructureSignalDictionary.xsd
@@ -51,6 +51,7 @@
                 <xs:element name="Enumerations" minOccurs="0" type="ssc:TEnumerations"/>
                 <xs:element name="Units" minOccurs="0" type="ssc:TUnits"/>
                 <xs:group ref="ssc:GMetaData"/>
+                <xs:group ref="ssc:GSignature"/>
                 <xs:element name="Annotations" minOccurs="0" type="ssc:TAnnotations"/>
             </xs:sequence>
             <xs:attribute name="version" use="required">