Skip to content

Commit

Permalink
Some small formal changes
Browse files Browse the repository at this point in the history
  • Loading branch information
PTaeuberDS committed Jul 30, 2024
1 parent 7d0af89 commit a71e7ad
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
12 changes: 6 additions & 6 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ There are alternative implementations depending on the use case and data availab
`fmi3IntermediateUpdateCallback` calls or the clocks mechanism could be used to synchronize DAQ lists.
For further details see <<External XCP Service>>.

It is also possible for an FMU to have integrated XCP service(s) and allow memory access for an external XCP service.
It is also possible for an FMU to have integrated XCP services and to allow memory access for an external XCP service.

The importer might also use the A2L address, type, layout and scaling information to use direct memory access into the virtual ECU.
As this approach does not use the standardized XCP protocol it is not further described in this layered standard.
Expand Down Expand Up @@ -146,7 +146,7 @@ Each `Interface` element has the <<table-schema-fmi-ls-xcp-interface-attributes,
|
| Relative URI
| This attribute must be a relative reference to a URI (formerly called a relative URI) to the A2L variable description file for this interface.
It may not contain any dot-segments (i.e. complete path segments of `.` or `..`).
It may not contain any dot-segments (i.e., complete path segments of `.` or `..`).
It is resolved to an absolute URI using a base URI that depends on the relevant FMU target, as defined in <<Structure of the FMU Archive>>.

|`types`
Expand Down Expand Up @@ -407,7 +407,7 @@ Enable XCP over TCP:: Determines whether the TCP instance of the XCP service pro
|Type |`Boolean`
|Example Start Value |`true`
|Requirement Type |Should be supplied, if the FMU provides an XCP service using TCP.
|If not present |Defaults to `true`, i.e. if the XCP slave supports TCP it will be started.
|If not present |Defaults to `true`, i.e., if the XCP slave supports TCP it will be started.
|===

TCP listen port number:: TCP port number where the XCP slave listens for XCP protocol commands.
Expand All @@ -427,7 +427,7 @@ TCP listen IP address:: IP address where the XCP slave listens for XCP protocol
|===
|Role |`XCPServiceTCPListenAddress`
|Type |`String`
|Example Start Value |`0.0.0.0`.
|Example Start Value |`0.0.0.0`
|Requirement Type |Should be supplied, if the FMU provides an XCP service using TCP.
|If not present |Defaults to the protocol data values found in the relevant A2L file.
|===
Expand All @@ -440,7 +440,7 @@ Enable XCP over UDP:: Determines whether the UDP instance of the XCP service pro
|Type |`Boolean`
|Example Start Value |`false`
|Requirement Type |Should be supplied, if the FMU provides an XCP service using UDP.
|If not present |Defaults to `true`, i.e. if the XCP slave supports UDP it will be started.
|If not present |Defaults to `true`, i.e., if the XCP slave supports UDP it will be started.
|===

UDP listen port number:: UDP port number where the XCP slave listens for XCP protocol commands.
Expand All @@ -460,7 +460,7 @@ UDP listen IP address:: IP address where the XCP slave listens for XCP protocol
|===
|Capability Attribute |`XCPServiceUDPListenAddress`
|Type |`String`
|Example Start Value |`0.0.0.0`.
|Example Start Value |`0.0.0.0`
|Requirement Type |Should be supplied, if the FMU provides an XCP service using UDP.
|If not present |Defaults to the protocol data values found in the relevant A2L file.
|===
Expand Down
24 changes: 12 additions & 12 deletions schema/fmi3LayeredStandardXcpManifest.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<xs:annotation>
<xs:documentation>
Copyright(c) 2023-2024 Modelica Association Project FMI.
All rights reserved.
All rights reserved.

This file is licensed by the copyright holders under the 2-Clause BSD License
(https://opensource.org/licenses/BSD-2-Clause):
Expand Down Expand Up @@ -32,7 +32,7 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
----------------------------------------------------------------------------
</xs:documentation>
</xs:documentation>
</xs:annotation>
<xs:element name="fmiLayeredStandardManifest">
<xs:complexType>
Expand Down Expand Up @@ -99,16 +99,16 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</xs:simpleType>
</xs:attribute>
<xs:attribute name="definition" type="xs:anyURI" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
This attribute must be a relative reference to a URI (formerly called a relative URI) to the A2L
definition file for this interface. It may not contain any dot-segments (i.e. complete path segments
of `.` or `..`). It is resolved to an absolute URI using a base URI as follows:
For any source FMU implementation this is resolved against the manifest file as the base URI,
for binary FMU implementations this is resolved against the corresponding target sub-directory
of the layered standard `extra` directory as the base URI.
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation xml:lang="en">
This attribute must be a relative reference to a URI (formerly called a relative URI) to the A2L
definition file for this interface. It may not contain any dot-segments (i.e., complete path segments
of `.` or `..`). It is resolved to an absolute URI using a base URI as follows:
For any source FMU implementation this is resolved against the manifest file as the base URI,
for binary FMU implementations this is resolved against the corresponding target sub-directory
of the layered standard `extra` directory as the base URI.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="containsXCPService" type="xs:boolean" default="false">
<xs:annotation>
Expand Down

0 comments on commit a71e7ad

Please sign in to comment.