# MBSimInterface - XML Documentation

XML-Namespace: http://www.mbsim-env.de/MBSimInterface

Contents

- 1 Introduction
- 2 Nomenclature
  - 2.1 Legend
  - 2.2 An element
  - 2.3 A choice of element
  - 2.4 A sequence of elements
  - 2.5 Nested sequences/choices
  - 2.6 Child Elements
- 3 Elements
  - <mbsim:Integrator>
    - <InterfaceIntegrator>
  - <MBSimServer>
    - <MBSimTcpServer>
- 4 Simple Types
  - AbsoluteExternSignalSourceReferenceType
  - AbsoluteSignalReferenceType

# 1 Introduction

TODO mbsimInterface-Dokumentation

# 2 Nomenclature

## 2.1 Legend

Icon | Description
--- | ---
<element> | A XML element of name 'element'
attrName | A XML attribute of name 'attrName'
namespace | A XML namespace of name 'namespace'
type | A XML element or attribute type of name 'type'
required | A required XML attribute
0-2 | A occurance of XML elements or attributes

## 2.2 An element

<ElementName> 0-2 elementType
attrName1 required typeOfTheAttribute
attrName2 optional typeOfTheAttribute

Documentation of the element.

The upper nomenclature defines a XML element named ElementName with (if given) a minimal occurance of 0 and a maximal occurance of 2. The element is of type elementType.
A occurance of optional means 0-1.
The element has two attributes named attrName1 and attrName2 of type typeOfTheAttribute. A attribute can be optional or required.

## 2.3 A choice of element

- 1-2
- <ElemenetA>
- <ElemenetB>

The upper nomenclature defines a choice of elements. Only one element of the given ones can be used. The choice has, if given, a minimal occurance of 1 and a maximal maximal occurence of 2.
A occurance of optional means 0-1.

## 2.4 A sequence of elements

- 0-3
- <ElemenetA>
- <ElemenetB>

The upper nomenclature defines a sequence of elements. Each element must be given in that order. The sequence has, if given, a minimal occurance of 0 and a maximal maximal occurence of 3.
A occurance of optional means 0-1.

## 2.5 Nested sequences/choices

- 1-2
- <ElemenetA>
- - 0-3
  - <ElemenetC>
  - <ElemenetD>
- <ElemenetB>

Sequences and choices can be nested like above.

## 2.6 Child Elements

- 1-2
- <ParantElemenet>
  - - 0-3
    - <ChildElemenetA>
    - <ChildElemenetB>

A indent indicates child elements for a given element.

# 3 Elements

<mbsim:Integrator>

This element is defined by the XML Schema (Project) with the namespace http://www.mbsim-env.de/MBSim, which is included by this XML Schema (Project). See the documentation of the included XML Schema (Project) for this element.

<InterfaceIntegrator>
Object properties

Abstract Element: | false
Inherits: | <mbsim:Integrator>
Inherited by: |
Attributes: |

Object documentation
Der InterfaceIntegrator stellt eine Schnittstelle zur MKS-Berechnung von MBSim dar.
Child Elements

- All Elements from <mbsim:Integrator>
- - <outputSignals>
    Sensorwerte, die mittels der IPC an das angeschlossene Programm weitergereicht werden.
    - - 0-unbounded
      - <signal>
        ref required AbsoluteSignalReferenceType
        Signal.
  - <inputSignals>
    Sensorwerte, die vom angeschlossenen Programm mittels der IPC als Eingangswerte in der MBSim-Berechnung dienen.
    - - 0-unbounded
      - <signal>
        ref required AbsoluteExternSignalSourceReferenceType
        Signal.
  - <methodForIPC>
    Auswahl einer Methode zur Interprozesskommunikation.
    - - <MBSimServer>
        Auswahl einer Methode zur Interprozesskommunikation.

    <InterfaceIntegrator xmlns="http://www.mbsim-env.de/MBSimInterface">
      <startTime xmlns="http://www.mbsim-env.de/MBSim">VALUE</startTime>
      <endTime xmlns="http://www.mbsim-env.de/MBSim">VALUE</endTime>
      <plotStepSize xmlns="http://www.mbsim-env.de/MBSim">VALUE</plotStepSize>
      <initialState xmlns="http://www.mbsim-env.de/MBSim">VALUE</initialState> <!-- optional -->
      <outputSignals>
        <signal ref="VALUE"/>
      </outputSignals>
      <inputSignals>
        <signal ref="VALUE"/>
      </inputSignals>
      <methodForIPC>
        <MBSimServer/> <!-- abstract -->
      </methodForIPC>
    </InterfaceIntegrator>

<MBSimServer>
Object properties

Abstract Element: | true
Inherits: |
Inherited by: | <MBSimTcpServer>,
Attributes: |

Object documentation
Schnittstelle zur Kommunikation mit dem Interface-Integrator.
Child Elements

<MBSimTcpServer>
Object properties

Abstract Element: | false
Inherits: | <MBSimServer>
Inherited by: |
Attributes: |

Object documentation
TcpServer.
Child Elements

- All Elements from <MBSimServer>
- - <port> pv:integerFullEval
    Port, auf dem der TCP-Server auf eingehende Verbindung wartet.
  - <outputPrecision> optional pv:nounitVector
    Anzahl der gültigen Stellen, mit dem der ascii-Output an den Port geschrieben wird.

    <MBSimTcpServer xmlns="http://www.mbsim-env.de/MBSimInterface">
      <port>VALUE</port>
      <outputPrecision>VALUE</outputPrecision> <!-- optional -->
    </MBSimTcpServer>

# 4 Simple Types

AbsoluteExternSignalSourceReferenceType

AbsoluteSignalReferenceType

Generated with MBXMLUtils on 2024-09-12T00:00:24Z