Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
modelica committed Nov 15, 2024
1 parent 958b945 commit f2f0610
Show file tree
Hide file tree
Showing 32 changed files with 79 additions and 33 deletions.
Binary file modified static/docs/main/images/SystemStructureCommon_Content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/docs/main/images/SystemStructureCommon_GMetaData.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/docs/main/images/SystemStructureCommon_MetaData.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/docs/main/images/SystemStructureCommon_Signature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/docs/main/images/image23.png
Binary file not shown.
Binary file removed static/docs/main/images/image25.png
Binary file not shown.
Binary file removed static/docs/main/images/image30.png
Binary file not shown.
Binary file removed static/docs/main/images/image32.png
Binary file not shown.
Binary file removed static/docs/main/images/image34.png
Binary file not shown.
Binary file removed static/docs/main/images/image35.png
Binary file not shown.
Binary file removed static/docs/main/images/image41.png
Binary file not shown.
Binary file removed static/docs/main/images/image45.png
Binary file not shown.
Binary file removed static/docs/main/images/image46.png
Binary file not shown.
80 changes: 54 additions & 26 deletions static/docs/main/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -586,8 +586,8 @@
<div id="header">
<h1>System Structure and Parameterization</h1>
<div class="details">
<span id="revnumber">version 9127c01,</span>
<span id="revdate">2024-11-08</span>
<span id="revnumber">version cdbd838,</span>
<span id="revdate">2024-11-15</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Contents</div>
Expand Down Expand Up @@ -683,7 +683,11 @@ <h1>System Structure and Parameterization</h1>
<ul class="sectlevel4">
<li><a href="#_metadata">4.5.4.1. MetaData</a></li>
<li><a href="#_content">4.5.4.2. Content</a></li>
<li><a href="#_signature">4.5.4.3. Signature</a></li>
</ul>
</li>
<li><a href="#ssc_signature">4.5.5. Signature Sequence</a>
<ul class="sectlevel4">
<li><a href="#_signature">4.5.5.1. Signature</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -2447,11 +2451,11 @@ <h5 id="_dimension">4.5.3.1. Dimension</h5>
<div class="sect3">
<h4 id="ssc_metadata">4.5.4. MetaData Sequence</h4>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureCommon_GMetaData.png" alt="image" width="597" height="196"></span></p>
<p><span class="image"><img src="images/SystemStructureCommon_GMetaData.png" alt="image" width="690" height="197"></span></p>
</div>
<div class="paragraph">
<p>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.</p>
<p>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.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
Expand All @@ -2470,17 +2474,12 @@ <h4 id="ssc_metadata">4.5.4. MetaData Sequence</h4>
<td class="tableblock halign-left valign-top"><p class="tableblock">One or more instances of this element <strong>CAN</strong> be present to specify meta data related to the containing model element.
See below for details.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Signature</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">One or more instances of this element <strong>CAN</strong> be present to specify signatures related to the containing model element.
See below for details.</p></td>
</tr>
</tbody>
</table>
<div class="sect4">
<h5 id="_metadata">4.5.4.1. MetaData</h5>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureCommon_MetaData.png" alt="image" width="369" height="543"></span></p>
<p><span class="image"><img src="images/SystemStructureCommon_MetaData.png" alt="image" width="462" height="479"></span></p>
</div>
<div class="paragraph">
<p>This element specifies a source of meta data related to the containing model element.</p>
Expand Down Expand Up @@ -2575,7 +2574,7 @@ <h5 id="_metadata">4.5.4.1. MetaData</h5>
<div class="sect4">
<h5 id="_content">4.5.4.2. Content</h5>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureCommon_Content.png" alt="image" width="377" height="306"></span></p>
<p><span class="image"><img src="images/SystemStructureCommon_Content.png" alt="image" width="372" height="191"></span></p>
</div>
<div class="paragraph">
<p>This element specifies the inlined content of the model element meta data.</p>
Expand All @@ -2585,10 +2584,39 @@ <h5 id="_content">4.5.4.2. Content</h5>
In that case there <strong>SHOULD</strong> be a layered specification that defines how embedding the content works for that MIME type.</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="ssc_signature">4.5.5. Signature Sequence</h4>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureCommon_GSignature.png" alt="image" width="652" height="133"></span></p>
</div>
<div class="paragraph">
<p>The group GSignature allows the specification of digital signatures for a given model element.
Multiple (or no) Signature elements may be present in a given model element.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33%;">
<col style="width: 67%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Element</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Signature</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">One or more instances of this element <strong>CAN</strong> be present to specify signatures related to the containing model element.
See below for details.</p></td>
</tr>
</tbody>
</table>
<div class="sect4">
<h5 id="_signature">4.5.4.3. Signature</h5>
<h5 id="_signature">4.5.5.1. Signature</h5>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureCommon_Signature.png" alt="image" width="423" height="534"></span></p>
<p><span class="image"><img src="images/SystemStructureCommon_Signature.png" alt="image" width="423" height="419"></span></p>
</div>
<div class="paragraph">
<p>This element specifies digital signature information on the data or meta data referenced by the enclosing element:
Expand Down Expand Up @@ -2699,7 +2727,7 @@ <h2 id="SSD">5. System Structure Description (SSD)</h2>
<div class="sect2">
<h3 id="_systemstructuredescription">5.1. SystemStructureDescription</h3>
<div class="paragraph">
<p><span class="image"><img src="images/image23.png" alt="image" width="464" height="506"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_SystemStructureDescription.png" alt="image" width="475" height="693"></span></p>
</div>
<div class="paragraph">
<p>The root element of an SSD file <strong>MUST</strong> 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.</p>
Expand Down Expand Up @@ -2818,7 +2846,7 @@ <h3 id="_common_model_element_type">5.2. Common Model Element Type</h3>
<p>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:</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/image25.png" alt="image" width="379" height="280"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_TElement.png" alt="image" width="391" height="466"></span></p>
</div>
<div class="paragraph">
<p>The following XML attributes are specified for the TElement type:</p>
Expand Down Expand Up @@ -3377,7 +3405,7 @@ <h4 id="_elementgeometry">5.2.2. ElementGeometry</h4>
<div class="sect3">
<h4 id="_parameterbindings">5.2.3. ParameterBindings</h4>
<div class="paragraph">
<p><span class="image"><img src="images/image32.png" alt="image" width="646" height="470"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_ParameterBindings.png" alt="image" width="746" height="719"></span></p>
</div>
<div class="paragraph">
<p>The ParameterBindings element provides the parameter bindings for a component or system, where each binding is specified in a ParameterBinding element.
Expand Down Expand Up @@ -3556,7 +3584,7 @@ <h5 id="_parametervalues">5.2.3.1. ParameterValues</h5>
<div class="sect4">
<h5 id="_parametermapping">5.2.3.2. ParameterMapping</h5>
<div class="paragraph">
<p><span class="image"><img src="images/image34.png" alt="image" width="441" height="355"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_ParameterMapping.png" alt="image" width="473" height="541"></span></p>
</div>
<div class="paragraph">
<p>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.
Expand Down Expand Up @@ -3617,7 +3645,7 @@ <h5 id="_parametermapping">5.2.3.2. ParameterMapping</h5>
<div class="sect2">
<h3 id="_system">5.3. System</h3>
<div class="paragraph">
<p><span class="image"><img src="images/image35.png" alt="image" width="452" height="641"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_System.png" alt="image" width="463" height="827"></span></p>
</div>
<div class="paragraph">
<p>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.</p>
Expand Down Expand Up @@ -4168,7 +4196,7 @@ <h4 id="_signaldictionaries">5.3.3. SignalDictionaries</h4>
<p>This optional element provides the set of defined signal dictionaries for the system.</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="images/image41.png" alt="image" width="415" height="336"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_SignalDictionary.png" alt="image" width="447" height="522"></span></p>
</div>
<div class="paragraph">
<p>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.</p>
Expand Down Expand Up @@ -4369,7 +4397,7 @@ <h5 id="_note">5.3.5.1. Note</h5>
<div class="sect2">
<h3 id="_component">5.4. Component</h3>
<div class="paragraph">
<p><span class="image"><img src="images/image45.png" alt="image" width="470" height="588"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_Component.png" alt="image" width="481" height="879"></span></p>
</div>
<div class="paragraph">
<p>A component is an atomic element of a system (i.e. its internal structure is not specified).</p>
Expand Down Expand Up @@ -4440,7 +4468,7 @@ <h3 id="_component">5.4. Component</h3>
<div class="sect2">
<h3 id="_signaldictionaryreference">5.5. SignalDictionaryReference</h3>
<div class="paragraph">
<p><span class="image"><img src="images/image46.png" alt="image" width="544" height="442"></span></p>
<p><span class="image"><img src="images/SystemStructureDescription_SignalDictionaryReference.png" alt="image" width="555" height="733"></span></p>
</div>
<div class="paragraph">
<p>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 <strong>MUST</strong> reference signal dictionary entries.</p>
Expand Down Expand Up @@ -4495,7 +4523,7 @@ <h2 id="SSV">6. System Structure Parameter Values (SSV)</h2>
<div class="sect2">
<h3 id="_parameterset">6.1. ParameterSet</h3>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureParameterValues_ParameterSet.png" alt="image" width="405" height="574"></span></p>
<p><span class="image"><img src="images/SystemStructureParameterValues_ParameterSet.png" alt="image" width="405" height="639"></span></p>
</div>
<div class="paragraph">
<p>The ParameterSet element contains parameter and meta data information.
Expand Down Expand Up @@ -5259,7 +5287,7 @@ <h2 id="SSM">7. System Structure Parameter Mapping (SSM)</h2>
<div class="sect2">
<h3 id="_parametermapping_2">7.1. ParameterMapping</h3>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureParameterMapping_ParameterMapping.png" alt="image" width="450" height="412"></span></p>
<p><span class="image"><img src="images/SystemStructureParameterMapping_ParameterMapping.png" alt="image" width="450" height="477"></span></p>
</div>
<div class="paragraph">
<p>This element describes a parameter mapping, which consists of multiple mapping entries, each describing one parameter mapping (see next section).
Expand Down Expand Up @@ -5380,7 +5408,7 @@ <h2 id="SSB">8. System Structure Signal Dictionaries (SSB)</h2>
<div class="sect2">
<h3 id="_signaldictionary">8.1. SignalDictionary</h3>
<div class="paragraph">
<p><span class="image"><img src="images/SystemStructureSignalDictionary_SignalDictionary.png" alt="image" width="438" height="520"></span></p>
<p><span class="image"><img src="images/SystemStructureSignalDictionary_SignalDictionary.png" alt="image" width="438" height="585"></span></p>
</div>
<div class="paragraph">
<p>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).</p>
Expand Down
11 changes: 8 additions & 3 deletions static/docs/main/schema/SystemStructureCommon.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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">
Expand All @@ -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"/>
Expand Down
13 changes: 9 additions & 4 deletions static/docs/main/schema/SystemStructureDescription.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"/>
Expand Down
5 changes: 5 additions & 0 deletions static/docs/main/schema/SystemStructureDescription11.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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"/>
Expand Down Expand Up @@ -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"/>
Expand Down Expand Up @@ -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"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
Loading

0 comments on commit f2f0610

Please sign in to comment.