Skip to content

Commit

Permalink
Harmonize formatting, one sentence per line
Browse files Browse the repository at this point in the history
  • Loading branch information
pmai committed Oct 25, 2024
1 parent 792ff6e commit 2231b4c
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 22 deletions.
39 changes: 27 additions & 12 deletions docs/4___common_content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ The following XML child elements denote the data type of a connector or dictiona
|Real / Float64 / Float32 / +
Integer / Int8 / UInt8 / Int16 / UInt16 / +
Int32 / UInt32 / Int64 / UInt64 / +
Boolean / String / Enumeration / Binary |Exactly one of these elements *MUST* be present to specify the type of the element. See below for details.
Boolean / String / Enumeration / Binary |Exactly one of these elements *MUST* be present to specify the type of the element.
See below for details.
|===

===== Real
Expand All @@ -186,11 +187,15 @@ This type specifies that the connector in question represents an IEEE754 double
[width="100%",cols="28%,72%",options="header",]
|===
|Attribute |Description
|unit |This optional attribute gives the name of a unit. The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file. +
|unit |This optional attribute gives the name of a unit.
The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file.

If the attribute is not supplied, the unit is determined through default mechanisms:
For FMU components, the unit of the underlying variable would be used, or no unit, if no unit is specified.
For systems, the units of connected underlying connectors could be used if unambiguous. +
If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error. +
For systems, the units of connected underlying connectors could be used if unambiguous.

If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error.

Notwithstanding these mechanisms, unitless variables of type Real are supported.
|===

Expand All @@ -203,11 +208,15 @@ This type specifies that the connector in question represents an IEEE754 double
[width="100%",cols="28%,72%",options="header",]
|===
|Attribute |Description
|unit |This optional attribute gives the name of a unit. The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file. +
|unit |This optional attribute gives the name of a unit.
The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file.

If the attribute is not supplied, the unit is determined through default mechanisms:
For FMU components, the unit of the underlying variable would be used, or no unit, if no unit is specified.
For systems, the units of connected underlying connectors could be used if unambiguous. +
If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error. +
For systems, the units of connected underlying connectors could be used if unambiguous.

If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error.

Notwithstanding these mechanisms, unitless variables of type Float64 are supported.
|===

Expand All @@ -220,11 +229,15 @@ This type specifies that the connector in question represents an IEEE754 single
[width="100%",cols="28%,72%",options="header",]
|===
|Attribute |Description
|unit |This optional attribute gives the name of a unit. The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file. +
|unit |This optional attribute gives the name of a unit.
The name *MUST* match the name of a Unit entry in the Units XML element of the top-level element of the file.

If the attribute is not supplied, the unit is determined through default mechanisms:
For FMU components, the unit of the underlying variable would be used, or no unit, if no unit is specified.
For systems, the units of connected underlying connectors could be used if unambiguous. +
If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error. +
For systems, the units of connected underlying connectors could be used if unambiguous.

If a unit (or its absence) cannot be deduced unambinguously, the user should be informed of this error.

Notwithstanding these mechanisms, unitless variables of type Float32 are supported.
|===

Expand Down Expand Up @@ -353,8 +366,10 @@ Linear transformations are only valid for connectors of Real, Float64 or Float32
[width="100%",cols="28%,72%",options="header",]
|===
|Attribute |Description
|factor |This attribute specifies an optional factor value to use in a linear transformation. The default is 1.
|offset |This attribute specifies an optional offset value to use in a transformation. The default is 0.
|factor |This attribute specifies an optional factor value to use in a linear transformation.
The default is 1.
|offset |This attribute specifies an optional offset value to use in a transformation.
The default is 0.
|===

===== BooleanMappingTransformation
Expand Down
29 changes: 20 additions & 9 deletions docs/5___ssd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ The following XML child elements are specified for the SystemStructureDescriptio
|===
|Element |Description
|System |This required element specifies the root system of the model, see <<System>>.
|Enumerations |This optional element *MUST* contain definitions for all enumerations referenced in the system description file. See <<Enumerations>> for its definition.
|Units |This optional element *MUST* contain definitions for all units referenced in the system description file. See <<Units>> for its definition.
|Enumerations |This optional element *MUST* contain definitions for all enumerations referenced in the system description file.
See <<Enumerations>> for its definition.
|Units |This optional element *MUST* contain definitions for all units referenced in the system description file.
See <<Units>> for its definition.
|DefaultExperiment |This optional element *MAY* contain information of a default simulation setup that is supplied with the system definition for informational purposes, see description below.
|===

Expand Down Expand Up @@ -152,10 +154,13 @@ The following XML child elements are specified for the Connector element:
|Real / Float64 / Float32 / +
Integer / Int8 / UInt8 / Int16 / UInt16 / +
Int32 / UInt32 / Int64 / UInt64 / +
Boolean / String / Enumeration / Binary / Clock |Exactly one of these elements *CAN* be present to specify the type of the Connector. See <<ssc_types>> for details.
|Dimension |One or more of these optional elements specify the connector array dimensions, making the connector an array connector. See <<ssc_dimensions>> for details.
Boolean / String / Enumeration / Binary / Clock |Exactly one of these elements *CAN* be present to specify the type of the Connector.
See <<ssc_types>> for details.
|Dimension |One or more of these optional elements specify the connector array dimensions, making the connector an array connector.
See <<ssc_dimensions>> for details.
|Clock |One or more of these optional elements associate the connector to a clock of the given name, which must be defined on the element that contains this connector.
|ConnectorGeometry |This optional element defines the geometry information of the connector. See below for details.
|ConnectorGeometry |This optional element defines the geometry information of the connector.
See below for details.
|===

The type of the Connector is identified by the presence of one of the XML child elements Real, Float64, Float32, Integer, Int8, UInt8, Int16, UInt16, Int32, UInt32, Int64, UInt64, Boolean, String, Enumeration, Binary, or Clock.
Expand Down Expand Up @@ -582,8 +587,11 @@ It is also implementation-defined whether and which connections between connecto

The table below applies directly to connectors of type `Clock` with an `intervalVariability` of `triggered`.
For connectors of type `Clock` with an `intervalVariability` that is not `triggered` the table applies with the following provisions:

* The connector is treated as a connector of kind `output` for the purposes of determining permissible connections.
* It is implementation-defined whether and which connections between two connectors of kind `input` with `intervalVariability` that is not `triggered` are allowed. Such connections are deemed to establish equality constraints on the clock ticks, where the resolution mechanism, including direction of resolution is implementation-defined.

* It is implementation-defined whether and which connections between two connectors of kind `input` with `intervalVariability` that is not `triggered` are allowed.
Such connections are deemed to establish equality constraints on the clock ticks, where the resolution mechanism, including direction of resolution is implementation-defined.

For all connections of an element connector of type `Clock` to a system connector of type `Clock`, the `intervalVariability` of the two connectors must be identical.

Expand Down Expand Up @@ -640,7 +648,8 @@ The following XML child elements are specified for the Connection element:
[width="100%",cols="42%,58%",options="header",]
|===
|Element |Description
|LinearTransformation / BooleanMappingTransformation / IntegerMappingTransformation / EnumerationMappingTransformation |Specifies an optional transformation for the connection. If any, exactly one of these elements *MUST* be present to specify the type of the transformation.
|LinearTransformation / BooleanMappingTransformation / IntegerMappingTransformation / EnumerationMappingTransformation |Specifies an optional transformation for the connection.
If any, exactly one of these elements *MUST* be present to specify the type of the transformation.
See <<Transformation Choice>> for details.
|ConnectionGeometry |This optional element defines the geometry information of the connection.
|===
Expand Down Expand Up @@ -696,7 +705,8 @@ No further types are currently defined, but can of course be added at a later da
This attribute indicates the source of the signal dictionary as a URI (cf. RFC 3986).
For purposes of the resolution of relative URIs the base URI is the URI of the SSD.

If the source attribute is missing, the signal dictionary *MUST* be provided inline as contents of the SignalDictionary element, which *MUST* be empty otherwise. For the default type `application/x-ssp-signal-dictionary` such inline content *MUST* be a SignalDictionary from the SystemStructureSignalDictionary namespace.
If the source attribute is missing, the signal dictionary *MUST* be provided inline as contents of the SignalDictionary element, which *MUST* be empty otherwise.
For the default type `application/x-ssp-signal-dictionary` such inline content *MUST* be a SignalDictionary from the SystemStructureSignalDictionary namespace.
See <<SSB>> for details.
|===

Expand Down Expand Up @@ -838,7 +848,8 @@ A signal dictionary reference is an element of a system that references a signal
|===
|Attribute |Description
|dictionary a|
This required attribute gives the name of the signal dictionary that is to be referenced. Name lookups occur in hierarchical fashion, i.e. the name is first looked up in the system that contains a signal dictionary reference.
This required attribute gives the name of the signal dictionary that is to be referenced.
Name lookups occur in hierarchical fashion, i.e. the name is first looked up in the system that contains a signal dictionary reference.
If that lookup yields no match, the lookup is performed on the enclosing system, etc., until a match is found.

It is an error if no matching signal dictionary is found.
Expand Down
3 changes: 2 additions & 1 deletion docs/7___ssm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ Through its optional GTransformationChoice element a transformation can be speci
|source |This required attribute specifies the name of the parameter in the parameter source that is to be mapped to a new name and/or provided with a transformation in this mapping entry.
|target |This required attribute specifies the name of the parameter in the system or component that is to be parametrized, i.e. that is the target of this mapping entry.
|suppressUnitConversion |This optional attribute specifies whether automatic conversions between parameter source and its target are performed using unit information potentially available for both value and target definitions.
If this attribute is supplied and its value is true, then the environment will not perform any automatic unit conversions, otherwise automatic unit conversions can be performed. +
If this attribute is supplied and its value is true, then the environment will not perform any automatic unit conversions, otherwise automatic unit conversions can be performed.

This is also important in conjunction with the optional linear transformation supplied via the LinearTransformation element: With suppressUnitConversion = true, the linear transformation is performed instead of any unit conversions, whereas otherwise the linear transformation is performed in addition to any unit conversions.
In that case the specified transformation will be done after any unit conversions have been performed on the value.
|===
Expand Down

0 comments on commit 2231b4c

Please sign in to comment.