Skip to content

Commit

Permalink
Adapt memberName for clock terminal variable within high-cut (#220)
Browse files Browse the repository at this point in the history 
* Adapt memberName for clock terminal variable within high-cut to be prepared for (possible) more clocks in the future
* Replaced "must be set to" by "must be"

---------

Co-authored-by: Benedikt Menne <BenediktM@dspace.de>
Co-authored-by: Pierre R. Mai <pmai@pmsf.de>
  • Loading branch information
@bmenne-dspace @pmai
3 people authored Dec 17, 2024
1 parent 897bf76 commit 66af1a1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
14 changes: 7 additions & 7 deletions docs/3____physical_signal_abstraction.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ _[e.g., `Powertrain`, if the file is `/extra/org.fmi-standard.fmi-ls-bus/Powertr
In any case, the attribute `name` of the `<Terminal>` must be consistent with the `BusName` component of all its corresponding signal, frame and Clock variables.

Attribute definitions::
* `terminalKind` must be set to `org.fmi-ls-bus.network-terminal`.
* `matchingRule` must be set to `bus`.
* `terminalKind` must be `org.fmi-ls-bus.network-terminal`.
* `matchingRule` must be `bus`.
* `name` is the network name, e.g., `Powertrain`, see <<high-cut-example, example>> and constraints above.

Element definitions::
Expand All @@ -92,24 +92,24 @@ If no <<high-cut-network-description-files,network description file>> is shipped
Each frame listed in the <<high-cut-network-description-files>> must be an element of its corresponding <<high-cut-bus-terminal>>.

Attribute definitions::
* `terminalKind` must be set to `org.fmi-ls-bus.frame-terminal`.
* `matchingRule` must be set to `bus`.
* `terminalKind` must be `org.fmi-ls-bus.frame-terminal`.
* `matchingRule` must be `bus`.
* `name` must match the frame name as defined in the <<high-cut-network-description-files>> in `/extra/org.fmi-standard.fmi-ls-bus`.

Element definitions::
* There must be no `<TerminalStreamMemberVariable>` element.
* There must be one <<high-cut-pdu-terminal>> element per PDU of this frame.
* There must be one `<TerminalMemberVariable>` for the Clock this frame is connected to.
The `memberName` of this variable must be "Clock".
The `memberName` of this variable must be `TransmissionClock`.

The <<high-cut-terminal-member-variable-for-signals>> must have the same `causality` as all variables referenced in the <<high-cut-pdu-terminal,PDU Terminals>> included here.

==== PDU Terminal [[high-cut-pdu-terminal,PDU terminal]]
Each PDU listed in the <<high-cut-network-description-files>> must be an element of its corresponding <<high-cut-frame-terminal>>.

Attribute definitions::
* `terminalKind` must be set to `org.fmi-ls-bus.pdu-terminal`.
* `matchingRule` must be set to `bus`.
* `terminalKind` must be `org.fmi-ls-bus.pdu-terminal`.
* `matchingRule` must be `bus`.
* `name` must match a PDU name of the <<high-cut-network-description-files>> in `/extra/org.fmi-standard.fmi-ls-bus`, if given.
For network types not natively referencing a "PDU", like CAN, a synthetic PDU with the same name as its frame is inserted.

Expand Down
10 changes: 5 additions & 5 deletions docs/images/terminal_relations.drawio
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<mxfile host="app.diagrams.net" modified="2023-12-21T10:29:07.021Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.0.0" etag="3bBwH0CDGb2SLA1lgUWg" version="22.1.11" type="device">
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0.0" version="24.9.3">
<diagram name="Page-1" id="NA00ltkQt7KQ1ODyW51z">
<mxGraphModel dx="1374" dy="765" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<mxGraphModel dx="903" dy="507" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
Expand All @@ -27,7 +27,7 @@
<mxCell id="0_vyEXYit7AstUDox_LG-6" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;„&lt;b&gt;&lt;span&gt;NetworkX&lt;/span&gt;&lt;span&gt;“&lt;/span&gt;&lt;span&gt;::Terminal&lt;/span&gt;&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;span&gt;&amp;nbsp; Name =&amp;nbsp;&lt;/span&gt;&lt;span&gt;&amp;lt;network name&lt;/span&gt;&lt;span&gt;&amp;gt;&lt;/span&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="37" y="142" width="160" height="70" as="geometry" />
</mxCell>
<mxCell id="0_vyEXYit7AstUDox_LG-13" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;TerminalMemberVariable&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuVariable&amp;gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; memberName = Tx_Data, Rx_Data,&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;Tx_Clock, Rx_Clock&amp;nbsp;&amp;nbsp;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/p&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxCell id="0_vyEXYit7AstUDox_LG-13" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;TerminalMemberVariable&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuVariable&amp;gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; memberName = Tx_Data, Rx_Data,&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;Tx_Clock, Rx_Clock&amp;nbsp;&amp;nbsp;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/p&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;fontSize=11;" parent="1" vertex="1">
<mxGeometry x="330" y="90" width="239.5" height="90" as="geometry" />
</mxCell>
<mxCell id="0_vyEXYit7AstUDox_LG-16" value="" style="endArrow=none;html=1;rounded=0;strokeWidth=3;dashed=1;exitX=0.003;exitY=0.378;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0.999;entryY=0.413;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" target="0_vyEXYit7AstUDox_LG-2" edge="1">
Expand Down Expand Up @@ -61,10 +61,10 @@
<mxCell id="0_vyEXYit7AstUDox_LG-20" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;„PduX“::Terminal&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; Name = &amp;lt;PDU name&amp;gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="91" y="389" width="160" height="70" as="geometry" />
</mxCell>
<mxCell id="0_vyEXYit7AstUDox_LG-21" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;TerminalMemberVariable&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuClock&amp;gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; memberName = &amp;lt;FrameName&amp;gt;&amp;nbsp;&amp;nbsp;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxCell id="0_vyEXYit7AstUDox_LG-21" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;TerminalMemberVariable&lt;/font&gt;&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuClock&amp;gt;&lt;/font&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; memberName = TransmissionClock&amp;nbsp;&amp;nbsp;&lt;/font&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/font&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="379" y="290" width="191" height="70" as="geometry" />
</mxCell>
<mxCell id="0_vyEXYit7AstUDox_LG-22" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;TerminalMemberVariable&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuVariable&amp;gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; memberName = &amp;lt;SignalName&amp;gt;&amp;nbsp;&amp;nbsp;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxCell id="0_vyEXYit7AstUDox_LG-22" value="&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;b&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;TerminalMemberVariable&lt;/font&gt;&lt;/b&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; variableName = &amp;lt;FmuVariable&amp;gt;&lt;/font&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; memberName = &amp;lt;SignalName&amp;gt;&amp;nbsp;&amp;nbsp;&lt;/font&gt;&lt;/p&gt;&lt;p style=&quot;margin-top: 0pt; margin-bottom: 0pt; margin-left: 0in; text-indent: 0in; direction: ltr; unicode-bidi: embed; word-break: normal;&quot;&gt;&lt;font style=&quot;font-size: 11px;&quot;&gt;&amp;nbsp; variableKind = signal&lt;/font&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="381.5" y="389" width="188.5" height="70" as="geometry" />
</mxCell>
<mxCell id="0_vyEXYit7AstUDox_LG-33" value="Text" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=1;" parent="1" vertex="1">
Expand Down
Loading

0 comments on commit 66af1a1

Please sign in to comment.