Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/1___overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,11 @@ The following companies and persons were involved in the creation of the standar

* Christian Bertsch, Bosch
* Dag Brück, Dassault Systèmes
* Markus Deppe, dSpace
* Markus Deppe, dSPACE
* Hans-Martin Heinkel, Bosch
* Maria Henningsson, Modelon
* Jan-Niklas Jäschke, TLK-Thermo
* Ulrich Kiffmeier, dSPACE
* Jochen Köhler, ZF Friedrichshafen
* Jürgen Krasser, AVL
* Peter Lobner, eXXcellent solutions
Expand Down
16 changes: 10 additions & 6 deletions docs/4___common_content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -462,17 +462,18 @@ This attribute references another connector by name, that gives the size of this
|===

[#ssc_metadata]
==== MetaData Sequence
==== MetaData and Signatures

image:images/SystemStructureCommon_GMetaData.png[image,width=597,height=196]

The MetaData element 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.
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.

[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.
|Signature |One or more instances of this element *CAN* be present to specify signatures related to the containing model element.
See below for details.
|===

Expand Down Expand Up @@ -507,15 +508,18 @@ The kind can be `general` or `quality`, indicating general meta data or quality
This mandatory attribute specifies the MIME type of the meta data, which does not have a default value.
If no specific MIME type can be indicated, then the type `application/octet-stream` is to be used.
|source a|
Optional attribute indicating the source of the meta data as a URI (cf. RFC 3986).
For purposes of the resolution of relative URIs the base URI is the URI of the SSD, if the sourceBase attribute is not specified or is specified as `SSD`, and the URI of the containing model element (e.g. component) if the base attribute is specified as `component`.
This attribute indicates the source of the resource meta data as a URI (cf. RFC 3986).
For purposes of the resolution of relative URIs the base URI is the URI of the SSD,
if the sourceBase attribute is not specified or is specified as SSD,
and the URI of the referenced resource if the sourceBase attribute is specified as resource.

This allows the specification of meta data sources that reside inside the component (for example an FMU) through relative URIs.

If the source attribute is missing, the meta data *MUST* be provided inline as contents of a Content element, which *MUST NOT* be present otherwise.
|sourceBase a|
Defines the base the source URI is resolved against:
If the attribute is missing or is specified as `SSD`, the source is resolved against the URI of the SSD, if the attribute is specified as `component` the URI is resolved against the (resolved) URI of the model element (e.g. component) source.
If the attribute is missing or is specified as SSD, the source is resolved against the URI of the SSD,
if the attribute is specified as resource the URI is resolved against the (resolved) URI of the resource source.
|===

===== Content
Expand Down
14 changes: 3 additions & 11 deletions docs/5___ssd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ The following XML child elements are specified for the SystemStructureDescriptio
|DefaultExperiment |This optional element *MAY* contain information of a default simulation setup that is supplied with the system definition for informational purposes, see description below.
|===

The root system of the model is specified through the required System element, see <<System>>.

Any enumerations and units referenced in the system description file *MUST* be provided through the optional Enumerations and Units elements, as described in <<Enumerations>> and <<Units>> respectively.

==== Default Experiment
Expand Down Expand Up @@ -95,8 +93,8 @@ For components the set of connectors *MUST* match variables/ports of the underly
For FMI 3.0 FMUs, the connector name has to match either the name of the corresponding variable element, or one of its <Alias> elements.

Names of variable elements of an FMU might follow the “Variable Naming Conventions” specification as defined by the FMI standard.
Hence, several ScalarVariables might be grouped as a structure or an array.
However, the name of a connector *MUST* match the name of a single <ScalarVariable>.
Hence, several variables might be grouped as a structure or an array.
However, the name of a connector *MUST* match the name of a single variable.

Note that there is no requirement that connectors have to be present for all variables/ports of an underlying component implementation.
At least those connectors *MUST* be present which are referenced in connections inside the SSD.
Expand Down Expand Up @@ -157,12 +155,6 @@ Boolean / String / Enumeration / Binary / Clock |Exactly one of these elements *
|ConnectorGeometry |This optional element defines the geometry information of the connector. See below for details.
|===

The type of the Connector is identified by the presence of one of the XML child elements Real, Float64, Float32, Integer, Int8, UInt8, Int16, UInt16, Int32, UInt32, Int64, UInt64, Boolean, String, Enumeration, Binary, or Clock.

The dimensionality of the Connector is given by the presence of one or more Dimension elements.

The association of a connector to a clock is given by the presence of one or more Clock elements.

When Modelica models are represented in SSP, built-in input and output connectors shall be mapped as follows:

[width="100%",cols="25%,25%,50%",options="header",]
Expand Down Expand Up @@ -410,7 +402,7 @@ For structural parameters it is assumed that the parameterization is applied in
This means that variables eligible for parameterization are those with:

* either causality = "input" or a start value for FMI 1.0
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0 or FMI 3.0

All kinds of system connectors can be parameterized.
In case the system level connectors are connected to FMU components, the parameterization *MUST* be compatible with the variable in the connected FMU.
Expand Down
8 changes: 4 additions & 4 deletions schema/SystemStructureCommon.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -312,17 +312,17 @@
<xs:documentation xml:lang="en">
This attribute indicates the source of the resource meta data as a
URI (cf. RFC 3986). For purposes of the resolution of relative URIs
the base URI is the URI of the STC, if the sourceBase attribute is
not specified or is specified as STC, and the URI of the referenced
the base URI is the URI of the SSD, if the sourceBase attribute is
not specified or is specified as SSD, and the URI of the referenced
resource if the sourceBase attribute is specified as resource.

This allows the specification of meta data sources that reside
inside the resource (e.g. an FMU) through relative URIs.

For meta data that are located alongside the STC, relative URIs
For meta data that are located alongside the SSD, relative URIs
without scheme and authority can and should be used to specify the
meta data sources. For meta data that are packaged inside an SSP
that contains this STC, this is mandatory (in this way, the STC
that contains this SSD, this is mandatory (in this way, the SSD
URIs remain valid after unpacking the SSP into the filesystem).

If the source attribute is missing, the meta data is provided
Expand Down