# MBSimXML - XML Documentation

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

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
  - <MBSimProject>
- 4 Simple Types

# 1 Introduction

# 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

<MBSimProject>
Object properties

Abstract Element: | false
Inherits: |
Inherited by: |
Attributes: | name required pv:stringPartialEval

Object documentation
Klasse für MBSim-Projekte
Child Elements

- - <pv:evaluator> optional
  - - <mbsim:DynamicSystemSolver>
      Modell.
    - <pv:Embed>
      Definition in externer Datei.
  - - <mbsim:Solver>
      Integrator.
    - <pv:Embed>
      Definition in externer Datei.

    <MBSimProject name="VALUE" xmlns="http://www.mbsim-env.de/MBSimXML">
      <DynamicSystemSolver name="VALUE" xmlns="http://www.mbsim-env.de/MBSim">
        <plotFeature/>
        <plotAttribute name="VALUE"/>
        <frameOfReference ref="VALUE"/> <!-- optional -->
        <frames>
          <FixedRelativeFrame name="VALUE">
            <plotFeature/>
            <plotAttribute name="VALUE"/>
            <enableOpenMBV/> <!-- optional -->
            <frameOfReference ref="VALUE"/> <!-- optional -->
            <relativePosition>VALUE</relativePosition> <!-- optional -->
            <relativeOrientation>VALUE</relativeOrientation> <!-- optional -->
          </FixedRelativeFrame>
        </frames>
        <contours>
          <Contour/> <!-- abstract -->
        </contours>
        <groups>
          <EmptyGroup/> <!-- abstract -->
        </groups>
        <objects>
          <Object/> <!-- abstract -->
        </objects>
        <links>
          <Link/> <!-- abstract -->
        </links>
        <constraints>
          <Constraint/> <!-- abstract -->
        </constraints>
        <observers>
          <Observer name="VALUE">
            <plotFeature/>
            <plotAttribute name="VALUE"/>
          </Observer>
        </observers>
        <enableOpenMBVFrameI/> <!-- optional -->
        <plotFeatureFrameI/> <!-- optional -->
        <environments>
          <Environment/> <!-- abstract -->
        </environments>
        <smoothSolver>VALUE</smoothSolver> <!-- optional -->
        <constraintSolver>VALUE</constraintSolver> <!-- optional -->
        <impactSolver>VALUE</impactSolver> <!-- optional -->
        <maximumNumberOfIterations>VALUE</maximumNumberOfIterations> <!-- optional -->
        <highNumberOfIterations>VALUE</highNumberOfIterations> <!-- optional -->
        <numericalJacobian>VALUE</numericalJacobian> <!-- optional -->
        <stopIfNoConvergence>VALUE</stopIfNoConvergence> <!-- optional -->
        <projectionTolerance>VALUE</projectionTolerance> <!-- optional -->
        <localSolverTolerance>VALUE</localSolverTolerance> <!-- optional -->
        <dynamicSystemSolverTolerance>VALUE</dynamicSystemSolverTolerance> <!-- optional -->
        <generalizedRelativePositionTolerance>VALUE</generalizedRelativePositionTolerance> <!-- optional -->
        <generalizedRelativeVelocityTolerance>VALUE</generalizedRelativeVelocityTolerance> <!-- optional -->
        <generalizedRelativeAccelerationTolerance>VALUE</generalizedRelativeAccelerationTolerance> <!-- optional -->
        <generalizedForceTolerance>VALUE</generalizedForceTolerance> <!-- optional -->
        <generalizedImpulseTolerance>VALUE</generalizedImpulseTolerance> <!-- optional -->
        <generalizedRelativePositionCorrectionValue>VALUE</generalizedRelativePositionCorrectionValue> <!-- optional -->
        <generalizedRelativeVelocityCorrectionValue>VALUE</generalizedRelativeVelocityCorrectionValue> <!-- optional -->
        <inverseKinetics>VALUE</inverseKinetics> <!-- optional -->
        <initialProjection>VALUE</initialProjection> <!-- optional -->
        <determineEquilibriumState>VALUE</determineEquilibriumState> <!-- optional -->
        <useConstraintSolverForSmoothMotion>VALUE</useConstraintSolverForSmoothMotion> <!-- optional -->
        <useConstraintSolverForPlot>VALUE</useConstraintSolverForPlot> <!-- optional -->
        <compressionLevel>VALUE</compressionLevel> <!-- optional -->
        <chunkSize>VALUE</chunkSize> <!-- optional -->
        <cacheSize>VALUE</cacheSize> <!-- optional -->
      </DynamicSystemSolver>
      <Solver xmlns="http://www.mbsim-env.de/MBSim"/> <!-- abstract -->
    </MBSimProject>

# 4 Simple Types

Generated with MBXMLUtils on 2024-09-12T00:01:46Z