Skip to content

Add Annotations support to fmiReferences and related elements #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Annotations support to fmiReferences and related elements #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c265988
Initial plan
Copilot May 6, 2026
70732e1
Add Annotations support to fmiReferences and related elements
Copilot May 6, 2026
3fe24b9
Add Annotations usage example to manifest example file
Copilot May 6, 2026
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
8 changes: 7 additions & 1 deletion docs/examples/fmi_ls_ref_manifest_example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@
fmi-ls:fmi-ls-version="1.0.0-alpha.1"
fmi-ls:fmi-ls-description="Layered Standard providing information on related files included in an FMU.">

<Related type="text/modelica" source="modelica/mymodel.mo" role="model" description="Modelica Model Source"/>
<Related type="text/modelica" source="modelica/mymodel.mo" role="model" description="Modelica Model Source">
<Annotations>
<Annotation type="com.example.tool">
<tool:metadata xmlns:tool="com.example.tool" reviewedBy="alice"/>
</Annotation>
</Annotations>
</Related>
<Related type="application/x-ssp-parameter-set" source="baseline-params.ssv" role="parameter" description="Baseline Model Parameters"/>
<Related type="application/x-ssp-parameter-set" source="midend-params.ssv" role="parameter" description="Midend Model Parameters"/>
<Related type="application/x-ssp-parameter-set" source="highend-params.ssv" role="parameter" description="Highend Model Parameters"/>
Expand Down
21 changes: 21 additions & 0 deletions docs/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ Beside these attributes the root element `fmiReferences` contains the following

|`<Related>`
|Each element describes one additional related file present in the FMU archive.

|`<Annotations>`
|Optional annotations as defined in the FMI standard.
|====

An example of a manifest file for this layered standard is shown below:
Expand Down Expand Up @@ -148,6 +151,18 @@ No base requirements on supported URI schemes are given in this layered standard
|Brief description of the related file that is suitable for display to users.
|====

The `<Related>` element contains the following elements:

.`<Related>` element details.
[[table-schema-fmi-ls-ref-related-elements]]
[cols="1,3"]
|====
|Element |Description

|`<Annotations>`
|Optional annotations as defined in the FMI standard.
|====

The `role` attribute is used to indicate the purpose of the related file.
A role can consist of a main role and optionally one or more sub-roles, separated by a forward slash (`/`), that indicate more specific purposes of the related file.
For example, the role `experiment/smoke-test` indicates that the related file is an experiment file that can be used to perform a smoke test validation of the FMU, while the role `experiment/validation` indicates that the related file is an experiment file that can be used to perform a detailed validation of the FMU.
Expand Down Expand Up @@ -315,6 +330,9 @@ Beside these attributes the root element `<Experiments>` contains the following

|`<Experiment>`
|Each element describes one experiment setup.

|`<Annotations>`
|Optional annotations as defined in the FMI standard.
|====

An example of an experiments file for this layered standard is shown below:
Expand Down Expand Up @@ -369,5 +387,8 @@ The `<Experiment>` element contains the following elements:

|`<References>`
|Reference results for the experiment setup.

|`<Annotations>`
|Optional annotations as defined in the FMI standard.
|====

9 changes: 9 additions & 0 deletions schema/fmi3LayeredStandardReferenceExperiments.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="qualified">
<xs:import schemaLocation="https://raw.githubusercontent.com/modelica/fmi-standard/main/schema/fmi3Annotation.xsd"/>
<xs:annotation>
<xs:documentation>
Copyright(c) 2023-2025 Modelica Association Project "FMI".
Expand Down Expand Up @@ -42,6 +43,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<xs:element name="Parameters" minOccurs="0" type="TParameters"/>
<xs:element name="Stimuli" minOccurs="0" type="TTimeSeriesData"/>
<xs:element name="References" minOccurs="0" type="TTimeSeriesData"/>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="description" type="xs:string"/>
Expand All @@ -51,13 +53,17 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<xs:attribute name="stepSize" type="xs:double"/>
</xs:complexType>
</xs:element>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="description" type="xs:string"/>
</xs:complexType>
</xs:element>

<xs:complexType name="TParameters">
<xs:sequence>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="type" type="xs:string" use="optional" default="application/x-ssp-parameter-set">
<xs:annotation>
<xs:documentation xml:lang="en">
Expand All @@ -80,6 +86,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</xs:complexType>

<xs:complexType name="TTimeSeriesData">
<xs:sequence>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="type" type="xs:string" use="optional" default="text/csv">
<xs:annotation>
<xs:documentation xml:lang="en">
Expand Down
5 changes: 5 additions & 0 deletions schema/fmi3LayeredStandardReferenceManifest.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:fmi-ls="http://fmi-standard.org/fmi-ls-manifest" elementFormDefault="qualified" attributeFormDefault="qualified">
<xs:import namespace="http://fmi-standard.org/fmi-ls-manifest" schemaLocation="https://raw.githubusercontent.com/modelica/fmi-standard/main/schema/fmi3LayeredStandardManifest.xsd"/>
<xs:import schemaLocation="https://raw.githubusercontent.com/modelica/fmi-standard/main/schema/fmi3Annotation.xsd"/>
<xs:annotation>
<xs:documentation>
Copyright(c) 2023-2025 Modelica Association Project "FMI".
Expand Down Expand Up @@ -38,6 +39,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<xs:complexType>
<xs:sequence>
<xs:element name="Related" minOccurs="0" maxOccurs="unbounded" type="TRelated"/>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute ref="fmi-ls:fmi-ls-name" use="required" fixed="org.fmi-standard.fmi-ls-ref"/>
<xs:attribute ref="fmi-ls:fmi-ls-version" use="required"/>
Expand All @@ -46,6 +48,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</xs:element>

<xs:complexType name="TRelated">
<xs:sequence>
<xs:element ref="Annotations" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="type" type="xs:string" use="optional" default="application/octet-stream">
<xs:annotation>
<xs:documentation xml:lang="en">
Expand Down
Loading