Skip to content

Commit 6cdd1f4

Browse files
authored
Merge pull request #45 from modelica/maint/minor-edits
Minor edits needed for release
2 parents 86eb74f + 195781c commit 6cdd1f4

9 files changed

+26
-22
lines changed

docs/1___overview.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ SSP is a tool-independent format for the description, packaging and exchange of
44
The standard is comprised of a set of XML-based formats to describe a network of component models with their signal flow and parametrization, as well as a ZIP-based packaging format for efficient distribution of entire systems, including any referenced models and other resources.
55
This description is tool neutral and is intended to be used primarly as an exchange format of simulation system descriptions between different tools.
66

7-
SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [FMI20].
7+
SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [FMI30].
88
FMI describes a tool independent standard to exchange single simulation models.
99
Using SSP, complete systems consisting of multiple interconnected simulation models can be defined with the desired signal flow and also with the wanted parameterization of each single model as well as the parameters for the complete system.
1010
This system topology can include hierarchies of sub-systems for proper structuring of the overall system.
@@ -52,7 +52,6 @@ From a simulation perspective, each component has to be described with its input
5252
This can be done using SSP by defining the wrapper of this component with an empty Component element comprising the connectors for the inputs and outputs and the component's parameters.
5353

5454
The interaction of the components is defined by the connections.
55-
Connections in SSP are always causal.
5655
Connections can be made directly between components or via signal dictionaries.
5756
A signal dictionary is a collection of signals similar to a bus concept (e.g. like a CAN bus).
5857
During the design phase of a system, a signal dictionary can be a good way to predefine the available signal connections.

docs/4___common_content.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The following XML child elements are specified for the Unit element:
136136
===== BaseUnit
137137

138138
This element defines the base unit of the given unit in SI units.
139-
This is completely aligned with the specification of base units in section 2.2.2 of the FMI 2.0 standard [FMI20].
139+
This is completely aligned with the specification of base units in section 2.4.3 of the FMI 3.0 standard [FMI30] and section 2.2.2 of the FMI 2.0 standard [FMI20].
140140

141141
image:images/image10.png[image,width=263,height=771]
142142

@@ -312,7 +312,7 @@ The name *MUST* match the name of an Enumeration entry in the Enumerations XML e
312312

313313
image:images/image17.png[image,width=319,height=114]
314314

315-
This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [OSMP120].
315+
This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [OSMP150].
316316

317317
[width="100%",cols="28%,72%",options="header",]
318318
|===
@@ -466,13 +466,15 @@ This attribute references another connector by name, that gives the size of this
466466

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

469-
The MetaData element allows the specification of additional meta data for a given model element.
470-
Multiple (or no) MetaData elements may be present in a given model element.
469+
The group GMetaData allows the specification of additional meta data and signatures for a given model element.
470+
Multiple (or no) MetaData and Signature elements may be present in a given model element.
471471

472472
[width="100%",cols="33%,67%",options="header",]
473473
|===
474-
|Element |Description
475-
|MetaData |One or more instances of this element *CAN* be present to specify meta data related to the containing model element.
474+
|Element |Description
475+
|MetaData |One or more instances of this element *CAN* be present to specify meta data related to the containing model element.
476+
See below for details.
477+
|Signature |One or more instances of this element *CAN* be present to specify signatures related to the containing model element.
476478
See below for details.
477479
|===
478480

docs/5___ssd.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ image:images/image24.png[image,width=449,height=248]
4242

4343
This element contains information of a default simulation setup that is supplied with the system definition for informational purposes.
4444

45-
{empty}[ _Note that in contrast to FMI 2.0 only start and stop time are specified here, since values like step size or tolerance depend on the specific solver or master algorithms employed and are hence not specified in this global element._
45+
{empty}[ _Note that in contrast to FMI 2.0/3.0 only start and stop time are specified here, since values like step size or tolerance depend on the specific solver or master algorithms employed and are hence not specified in this global element._
4646
_Additional solver or master algorithm specific information can be supplied through the annotation mechanism, or using a future layered standard._ ]
4747

4848
{empty}[ _The handling of systems comprising components with differing units for the independent variable depends on the implementation._
@@ -91,12 +91,12 @@ See below for details.
9191
image:images/image26.png[image,width=371,height=82]
9292

9393
This optional element specifies the set of connectors of this model element, which represent the interface of the model element to the outside world.
94-
For components the set of connectors *MUST* match variables/ports of the underlying component implementation, e.g., for referenced FMI 2.0 FMUs, the name of a connector has to match the name attribute of the corresponding <ScalarVariable> element; for referenced FMUs that follow the OSI Sensor Model Packaging specification [OSMP120], the name of a connector of type Binary has to match the name attribute of the corresponding <osmp:osmp-binary-variable>.
94+
For components the set of connectors *MUST* match variables/ports of the underlying component implementation, e.g., for referenced FMI 2.0 FMUs, the name of a connector has to match the name attribute of the corresponding <ScalarVariable> element; for referenced FMUs that follow the OSI Sensor Model Packaging specification [OSMP150], the name of a connector of type Binary has to match the name attribute of the corresponding <osmp:osmp-binary-variable>.
9595
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.
9696

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

101101
Note that there is no requirement that connectors have to be present for all variables/ports of an underlying component implementation.
102102
At least those connectors *MUST* be present which are referenced in connections inside the SSD.
@@ -410,7 +410,7 @@ For structural parameters it is assumed that the parameterization is applied in
410410
This means that variables eligible for parameterization are those with:
411411

412412
* either causality = "input" or a start value for FMI 1.0
413-
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0
413+
* variability != "constant" and initial = "exact" or "approx" for FMI 2.0/3.0
414414

415415
All kinds of system connectors can be parameterized.
416416
In case the system level connectors are connected to FMU components, the parameterization *MUST* be compatible with the variable in the connected FMU.

docs/A___literature.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ https://semver.org/spec/v2.0.0.html
1212
[XML10] World Wide Web Consortium: *Extensible Markup Language (XML) 1.0 (Fifth Edition).* W3C Recommendation. 2008. +
1313
http://www.w3.org/TR/2008/REC-xml-20081126/
1414

15-
[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.3.* 2021. +
16-
https://github.com/modelica/fmi-standard/releases/download/v2.0.3/FMI-Specification-2.0.3.pdf
15+
[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.4.* 2022. +
16+
https://github.com/modelica/fmi-standard/releases/download/v2.0.4/FMI-Specification-2.0.4.pdf
1717

18-
[OSMP120] ASAM e.V.: *OSI Sensor Model Packaging Version 1.2.0.* 2021. +
19-
https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/releases/tag/v1.2.0
18+
[FMI30] Modelica Association: *Functional Mock-up Interface Specification, Version 3.0.1.* 2023. +
19+
https://fmi-standard.org/docs/3.0.1/
20+
21+
[OSMP150] ASAM e.V.: *OSI Sensor Model Packaging Version 1.5.0.* 2024. +
22+
https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/releases/tag/v1.5.0

schema/SystemStructureDescription.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Version: 2.0-alpha
1212

13-
Copyright 2016 -- 2019 Modelica Association Project "SSP"
13+
Copyright 2016 -- 2024 Modelica Association Project "SSP"
1414

1515
Redistribution and use in source and binary forms, with or
1616
without modification, are permitted provided that the

schema/SystemStructureDescription11.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
Version: 2.0-alpha
1818

19-
Copyright 2016 -- 2019 Modelica Association Project "SSP"
19+
Copyright 2016 -- 2024 Modelica Association Project "SSP"
2020

2121
Redistribution and use in source and binary forms, with or
2222
without modification, are permitted provided that the

schema/SystemStructureParameterMapping.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Version: 2.0-alpha
1212

13-
Copyright 2016 -- 2019 Modelica Association Project "SSP"
13+
Copyright 2016 -- 2024 Modelica Association Project "SSP"
1414

1515
Redistribution and use in source and binary forms, with or
1616
without modification, are permitted provided that the

schema/SystemStructureParameterValues.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Version: 2.0-alpha
1212

13-
Copyright 2016 -- 2019 Modelica Association Project "SSP"
13+
Copyright 2016 -- 2024 Modelica Association Project "SSP"
1414

1515
Redistribution and use in source and binary forms, with or
1616
without modification, are permitted provided that the

schema/SystemStructureSignalDictionary.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Version: 2.0-alpha
1212

13-
Copyright 2016 -- 2019 Modelica Association Project "SSP"
13+
Copyright 2016 -- 2024 Modelica Association Project "SSP"
1414

1515
Redistribution and use in source and binary forms, with or
1616
without modification, are permitted provided that the

0 commit comments

Comments
 (0)