Skip to content

Commit

Permalink
Merge pull request #195 from pmai/fix/highcut_variable_names
Browse files Browse the repository at this point in the history
Only recommend high-cut variable names
  • Loading branch information
pmai authored Oct 22, 2024
2 parents 1f332b6 + eddf457 commit e141aae
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/3____physical_signal_abstraction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,10 @@ All <<high-cut-terminal-member-variable-for-signals,`TerminalMemberVariables`>>
<<high-cut-pdu-terminal,PDU terminals>> list all the contained signals as `<TerminalMemberVariable>`.

Attribute definitions::
* `variableName` refers to the input or output variable name of the FMU and to enforce uniqueness is built as follows: `BusName.FrameName.PDUName.SignalName`, e.g., `Powertrain.tcuSensors.tcuSensors.vCar`.
* `variableName` refers to the input or output variable name of the FMU.
These variables represent the signal abstraction layer ("high cut").
Unless there are other requirements, it is recommended to build the variable names as follows: `BusName.FrameName.PDUName.SignalName`, e.g., `Powertrain.tcuSensors.tcuSensors.vCar`.
This approach automatically provides unique names for all bus-related variables, and can also be used for the clock variables, to allow automatic grouping by non-terminal-aware tools.
* `memberName` is the `SignalName` as given in the <<high-cut-network-description-files>>, e.g., `vCar`, if given.
This is redundant information but simplifies signal name extraction.
* `variableKind` is `signal`.
Expand Down

0 comments on commit e141aae

Please sign in to comment.