Skip to content
Open
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
17 changes: 13 additions & 4 deletions docs/examples/fmi_ls_ref_manifest_example.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,18 @@
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="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"/>
<Related type="application/x-ssp-parameter-set" source="baseline-params.ssv" role="parameter" description="Baseline Model Parameters">
<Label name="variant:baseline" description="Baseline variant parameters"/>
</Related>
<Related type="application/x-ssp-parameter-set" source="midend-params.ssv" role="parameter" description="Midend Model Parameters">
<Label name="variant:midend" description="Midend variant parameters"/>
</Related>
<Related type="application/x-ssp-parameter-set" source="highend-params.ssv" role="parameter" description="Highend Model Parameters">
<Label name="variant:highend" description="Highend variant parameters"/>
</Related>
<Related type="application/x-ssp-parameter-set" source="dynamic-params.ssv" role="parameter" description="Dynamic Model Parameters"/>
<Related type="application/x-ma-ls-experiments" source="smoke-tests.exp" role="experiment" description="Smoke Tests of FMU"/>
<Related type="application/x-ma-ls-experiments" source="smoke-tests.exp" role="experiment" description="Smoke Tests of FMU">
<Label name="simulation-type:SIL" description="Applicable for Software-in-the-Loop simulation"/>
<Label name="os:Win64" description="Applicable for Windows 64-bit target"/>
</Related>
</fmiReferences>
35 changes: 35 additions & 0 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,41 @@ 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 can contain the following child elements:

.Related Child Elements.
[[table-schema-fmi-ls-ref-related-elements]]
[cols="1,3"]
|====
|Element |Description

|`<Label>`
|Each element assigns a label to the related file, which can be used to categorize or filter related files for a certain use case.
Zero or more `<Label>` elements may be present.
|====

==== Labels

Labels can be used to categorize related files and to filter them for a certain use case.
For example, labels can be used to filter for a certain variant, to filter files which are relevant for SIL or HIL simulation, or to filter for different target operating systems.

The `<Label>` element contains the following attributes:

.Label Attributes.
[[table-schema-fmi-ls-ref-label-attributes]]
[cols="1,1,2"]
|====
|Attribute |Presence |Description

|`name`
|Required
|Name of the label.

|`description`
|Optional
|Brief description of the label that is suitable for display to users.
|====

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
20 changes: 20 additions & 0 deletions schema/fmi3LayeredStandardReferenceManifest.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</xs:element>

<xs:complexType name="TRelated">
<xs:sequence>
<xs:element name="Label" minOccurs="0" maxOccurs="unbounded" type="TLabel"/>
</xs:sequence>
<xs:attribute name="type" type="xs:string" use="optional" default="application/octet-stream">
<xs:annotation>
<xs:documentation xml:lang="en">
Expand Down Expand Up @@ -77,4 +80,21 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</xs:attribute>
<xs:attribute name="description" type="xs:string"/>
</xs:complexType>

<xs:complexType name="TLabel">
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
This attribute specifies the name of the label used to categorize or filter the related resource.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="description" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
This optional attribute provides a brief description of the label.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:schema>
Loading