fmu-manipulation-toolbox 1.7.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. fmu_manipulation_toolbox/__init__.py +1 -0
  2. fmu_manipulation_toolbox/__main__.py +25 -0
  3. fmu_manipulation_toolbox/__version__.py +1 -0
  4. fmu_manipulation_toolbox/checker.py +61 -0
  5. fmu_manipulation_toolbox/cli.py +216 -0
  6. fmu_manipulation_toolbox/fmu_container.py +784 -0
  7. fmu_manipulation_toolbox/fmu_operations.py +489 -0
  8. fmu_manipulation_toolbox/gui.py +493 -0
  9. fmu_manipulation_toolbox/help.py +87 -0
  10. fmu_manipulation_toolbox/resources/checkbox-checked-disabled.png +0 -0
  11. fmu_manipulation_toolbox/resources/checkbox-checked-hover.png +0 -0
  12. fmu_manipulation_toolbox/resources/checkbox-checked.png +0 -0
  13. fmu_manipulation_toolbox/resources/checkbox-unchecked-disabled.png +0 -0
  14. fmu_manipulation_toolbox/resources/checkbox-unchecked-hover.png +0 -0
  15. fmu_manipulation_toolbox/resources/checkbox-unchecked.png +0 -0
  16. fmu_manipulation_toolbox/resources/drop_fmu.png +0 -0
  17. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2Annotation.xsd +58 -0
  18. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2AttributeGroups.xsd +78 -0
  19. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ModelDescription.xsd +345 -0
  20. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ScalarVariable.xsd +218 -0
  21. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2Type.xsd +89 -0
  22. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2Unit.xsd +116 -0
  23. fmu_manipulation_toolbox/resources/fmi-2.0/fmi2VariableDependency.xsd +92 -0
  24. fmu_manipulation_toolbox/resources/fmu.png +0 -0
  25. fmu_manipulation_toolbox/resources/fmu_manipulation_toolbox.png +0 -0
  26. fmu_manipulation_toolbox/resources/help.png +0 -0
  27. fmu_manipulation_toolbox/resources/icon.png +0 -0
  28. fmu_manipulation_toolbox/resources/license.txt +34 -0
  29. fmu_manipulation_toolbox/resources/linux32/client_sm.so +0 -0
  30. fmu_manipulation_toolbox/resources/linux32/server_sm +0 -0
  31. fmu_manipulation_toolbox/resources/linux64/client_sm.so +0 -0
  32. fmu_manipulation_toolbox/resources/linux64/container.so +0 -0
  33. fmu_manipulation_toolbox/resources/linux64/server_sm +0 -0
  34. fmu_manipulation_toolbox/resources/model.png +0 -0
  35. fmu_manipulation_toolbox/resources/win32/client_sm.dll +0 -0
  36. fmu_manipulation_toolbox/resources/win32/server_sm.exe +0 -0
  37. fmu_manipulation_toolbox/resources/win64/client_sm.dll +0 -0
  38. fmu_manipulation_toolbox/resources/win64/container.dll +0 -0
  39. fmu_manipulation_toolbox/resources/win64/server_sm.exe +0 -0
  40. fmu_manipulation_toolbox/version.py +9 -0
  41. fmu_manipulation_toolbox-1.7.5.dist-info/LICENSE.txt +22 -0
  42. fmu_manipulation_toolbox-1.7.5.dist-info/METADATA +20 -0
  43. fmu_manipulation_toolbox-1.7.5.dist-info/RECORD +46 -0
  44. fmu_manipulation_toolbox-1.7.5.dist-info/WHEEL +5 -0
  45. fmu_manipulation_toolbox-1.7.5.dist-info/entry_points.txt +3 -0
  46. fmu_manipulation_toolbox-1.7.5.dist-info/top_level.txt +1 -0
fmu_manipulation_toolbox/resources/fmi-2.0/fmi2AttributeGroups.xsd ADDED
@@ -0,0 +1,78 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
+ <xs:annotation>
4
+ <xs:documentation>
5
+ Copyright(c) 2008-2011 MODELISAR consortium,
6
+ 2012-2022 Modelica Association Project "FMI".
7
+ All rights reserved.
8
+
9
+ This schema file is part of the FMI 2.0.4 standard.
10
+
11
+ This file is licensed by the copyright holders under the 2-Clause BSD License
12
+ (https://opensource.org/licenses/BSD-2-Clause):
13
+
14
+ ----------------------------------------------------------------------------
15
+ Redistribution and use in source and binary forms, with or without
16
+ modification, are permitted provided that the following conditions are met:
17
+
18
+ - Redistributions of source code must retain the above copyright notice,
19
+ this list of conditions and the following disclaimer.
20
+
21
+ - Redistributions in binary form must reproduce the above copyright notice,
22
+ this list of conditions and the following disclaimer in the documentation
23
+ and/or other materials provided with the distribution.
24
+
25
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27
+ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
29
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
32
+ OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
35
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36
+ ----------------------------------------------------------------------------
37
+ </xs:documentation>
38
+ </xs:annotation>
39
+ <xs:attributeGroup name="fmi2RealAttributes">
40
+ <xs:attribute name="quantity" type="xs:normalizedString"/>
41
+ <xs:attribute name="unit" type="xs:normalizedString"/>
42
+ <xs:attribute name="displayUnit" type="xs:normalizedString">
43
+ <xs:annotation>
44
+ <xs:documentation>Default display unit, provided the conversion of values in "unit" to values in "displayUnit" is defined in UnitDefinitions / Unit / DisplayUnit.</xs:documentation>
45
+ </xs:annotation>
46
+ </xs:attribute>
47
+ <xs:attribute name="relativeQuantity" type="xs:boolean" default="false">
48
+ <xs:annotation>
49
+ <xs:documentation>If relativeQuantity=true, offset for displayUnit must be ignored.</xs:documentation>
50
+ </xs:annotation>
51
+ </xs:attribute>
52
+ <xs:attribute name="min" type="xs:double"/>
53
+ <xs:attribute name="max" type="xs:double">
54
+ <xs:annotation>
55
+ <xs:documentation>max >= min required</xs:documentation>
56
+ </xs:annotation>
57
+ </xs:attribute>
58
+ <xs:attribute name="nominal" type="xs:double">
59
+ <xs:annotation>
60
+ <xs:documentation>nominal > 0.0 required</xs:documentation>
61
+ </xs:annotation>
62
+ </xs:attribute>
63
+ <xs:attribute name="unbounded" type="xs:boolean" default="false">
64
+ <xs:annotation>
65
+ <xs:documentation>Set to true, e.g., for crank angle. If true and variable is a state, relative tolerance should be zero on this variable.</xs:documentation>
66
+ </xs:annotation>
67
+ </xs:attribute>
68
+ </xs:attributeGroup>
69
+ <xs:attributeGroup name="fmi2IntegerAttributes">
70
+ <xs:attribute name="quantity" type="xs:normalizedString"/>
71
+ <xs:attribute name="min" type="xs:int"/>
72
+ <xs:attribute name="max" type="xs:int">
73
+ <xs:annotation>
74
+ <xs:documentation>max >= min required</xs:documentation>
75
+ </xs:annotation>
76
+ </xs:attribute>
77
+ </xs:attributeGroup>
78
+ </xs:schema>
fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ModelDescription.xsd ADDED
@@ -0,0 +1,345 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
+ <xs:include schemaLocation="fmi2ScalarVariable.xsd"/>
4
+ <xs:include schemaLocation="fmi2VariableDependency.xsd"/>
5
+ <xs:include schemaLocation="fmi2Unit.xsd"/>
6
+ <xs:include schemaLocation="fmi2Type.xsd"/>
7
+ <xs:annotation>
8
+ <xs:documentation>
9
+ Copyright(c) 2008-2011 MODELISAR consortium,
10
+ 2012-2022 Modelica Association Project "FMI".
11
+ All rights reserved.
12
+
13
+ This schema file is part of the FMI 2.0.4 standard.
14
+
15
+ This file is licensed by the copyright holders under the 2-Clause BSD License
16
+ (https://opensource.org/licenses/BSD-2-Clause):
17
+
18
+ ----------------------------------------------------------------------------
19
+ Redistribution and use in source and binary forms, with or without
20
+ modification, are permitted provided that the following conditions are met:
21
+
22
+ - Redistributions of source code must retain the above copyright notice,
23
+ this list of conditions and the following disclaimer.
24
+
25
+ - Redistributions in binary form must reproduce the above copyright notice,
26
+ this list of conditions and the following disclaimer in the documentation
27
+ and/or other materials provided with the distribution.
28
+
29
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31
+ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
33
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
34
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
35
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
36
+ OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
37
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
38
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
39
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
+ ----------------------------------------------------------------------------
41
+ </xs:documentation>
42
+ </xs:annotation>
43
+ <xs:element name="fmiModelDescription">
44
+ <xs:complexType>
45
+ <xs:sequence>
46
+ <xs:sequence maxOccurs="2">
47
+ <xs:annotation>
48
+ <xs:documentation>At least one of the elements must be present</xs:documentation>
49
+ </xs:annotation>
50
+ <xs:element name="ModelExchange" minOccurs="0">
51
+ <xs:annotation>
52
+ <xs:documentation>The FMU includes a model or the communication to a tool that provides a model. The environment provides the simulation engine for the model.</xs:documentation>
53
+ </xs:annotation>
54
+ <xs:complexType>
55
+ <xs:annotation>
56
+ <xs:documentation>List of capability flags that an FMI2 Model Exchange interface can provide</xs:documentation>
57
+ </xs:annotation>
58
+ <xs:sequence>
59
+ <xs:element name="SourceFiles" minOccurs="0">
60
+ <xs:annotation>
61
+ <xs:documentation>List of source file names that are present in the "sources" directory of the FMU and need to be compiled in order to generate the binary of the FMU (only meaningful for source code FMUs).</xs:documentation>
62
+ </xs:annotation>
63
+ <xs:complexType>
64
+ <xs:sequence maxOccurs="unbounded">
65
+ <xs:element name="File">
66
+ <xs:complexType>
67
+ <xs:attribute name="name" type="xs:normalizedString" use="required">
68
+ <xs:annotation>
69
+ <xs:documentation>Name of the file including the path relative to the sources directory, using the forward slash as separator (for example: name = "myFMU.c"; name = "modelExchange/solve.c") </xs:documentation>
70
+ </xs:annotation>
71
+ </xs:attribute>
72
+ </xs:complexType>
73
+ </xs:element>
74
+ </xs:sequence>
75
+ </xs:complexType>
76
+ </xs:element>
77
+ </xs:sequence>
78
+ <xs:attribute name="modelIdentifier" type="xs:normalizedString" use="required">
79
+ <xs:annotation>
80
+ <xs:documentation>Short class name according to C-syntax, e.g. "A_B_C". Used as prefix for FMI2 functions if the functions are provided in C source code or in static libraries, but not if the functions are provided by a DLL/SharedObject. modelIdentifier is also used as name of the static library or DLL/SharedObject.</xs:documentation>
81
+ </xs:annotation>
82
+ </xs:attribute>
83
+ <xs:attribute name="needsExecutionTool" type="xs:boolean" default="false">
84
+ <xs:annotation>
85
+ <xs:documentation>If true, a tool is needed to execute the model and the FMU just contains the communication to this tool.</xs:documentation>
86
+ </xs:annotation>
87
+ </xs:attribute>
88
+ <xs:attribute name="completedIntegratorStepNotNeeded" type="xs:boolean" default="false"/>
89
+ <xs:attribute name="canBeInstantiatedOnlyOncePerProcess" type="xs:boolean" default="false"/>
90
+ <xs:attribute name="canNotUseMemoryManagementFunctions" type="xs:boolean" default="false"/>
91
+ <xs:attribute name="canGetAndSetFMUstate" type="xs:boolean" default="false"/>
92
+ <xs:attribute name="canSerializeFMUstate" type="xs:boolean" default="false"/>
93
+ <xs:attribute name="providesDirectionalDerivative" type="xs:boolean" default="false"/>
94
+ </xs:complexType>
95
+ </xs:element>
96
+ <xs:element name="CoSimulation" minOccurs="0">
97
+ <xs:annotation>
98
+ <xs:documentation>The FMU includes a model and the simulation engine, or the communication to a tool that provides this. The environment provides the master algorithm for the Co-Simulation coupling.</xs:documentation>
99
+ </xs:annotation>
100
+ <xs:complexType>
101
+ <xs:sequence>
102
+ <xs:element name="SourceFiles" minOccurs="0">
103
+ <xs:annotation>
104
+ <xs:documentation>List of source file names that are present in the "sources" directory of the FMU and need to be compiled in order to generate the binary of the FMU (only meaningful for source code FMUs).</xs:documentation>
105
+ </xs:annotation>
106
+ <xs:complexType>
107
+ <xs:sequence maxOccurs="unbounded">
108
+ <xs:element name="File">
109
+ <xs:complexType>
110
+ <xs:attribute name="name" type="xs:normalizedString" use="required">
111
+ <xs:annotation>
112
+ <xs:documentation>Name of the file including the path relative to the sources directory, using the forward slash as separator (for example: name = "myFMU.c"; name = "coSimulation/solve.c") </xs:documentation>
113
+ </xs:annotation>
114
+ </xs:attribute>
115
+ </xs:complexType>
116
+ </xs:element>
117
+ </xs:sequence>
118
+ </xs:complexType>
119
+ </xs:element>
120
+ </xs:sequence>
121
+ <xs:attribute name="modelIdentifier" type="xs:normalizedString" use="required">
122
+ <xs:annotation>
123
+ <xs:documentation>Short class name according to C-syntax, e.g. "A_B_C". Used as prefix for FMI2 functions if the functions are provided in C source code or in static libraries, but not if the functions are provided by a DLL/SharedObject. modelIdentifier is also used as name of the static library or DLL/SharedObject.</xs:documentation>
124
+ </xs:annotation>
125
+ </xs:attribute>
126
+ <xs:attribute name="needsExecutionTool" type="xs:boolean" default="false">
127
+ <xs:annotation>
128
+ <xs:documentation>If true, a tool is needed to execute the model and the FMU just contains the communication to this tool.</xs:documentation>
129
+ </xs:annotation>
130
+ </xs:attribute>
131
+ <xs:attribute name="canHandleVariableCommunicationStepSize" type="xs:boolean" default="false"/>
132
+ <xs:attribute name="canInterpolateInputs" type="xs:boolean" default="false"/>
133
+ <xs:attribute name="maxOutputDerivativeOrder" type="xs:unsignedInt" default="0"/>
134
+ <xs:attribute name="canRunAsynchronuously" type="xs:boolean" default="false"/>
135
+ <xs:attribute name="canBeInstantiatedOnlyOncePerProcess" type="xs:boolean" default="false"/>
136
+ <xs:attribute name="canNotUseMemoryManagementFunctions" type="xs:boolean" default="false"/>
137
+ <xs:attribute name="canGetAndSetFMUstate" type="xs:boolean" default="false"/>
138
+ <xs:attribute name="canSerializeFMUstate" type="xs:boolean" default="false"/>
139
+ <xs:attribute name="providesDirectionalDerivative" type="xs:boolean" default="false">
140
+ <xs:annotation>
141
+ <xs:documentation>Directional derivatives at communication points</xs:documentation>
142
+ </xs:annotation>
143
+ </xs:attribute>
144
+ </xs:complexType>
145
+ </xs:element>
146
+ </xs:sequence>
147
+ <xs:element name="UnitDefinitions" minOccurs="0">
148
+ <xs:complexType>
149
+ <xs:sequence maxOccurs="unbounded">
150
+ <xs:element name="Unit" type="fmi2Unit"/>
151
+ </xs:sequence>
152
+ </xs:complexType>
153
+ </xs:element>
154
+ <xs:element name="TypeDefinitions" minOccurs="0">
155
+ <xs:complexType>
156
+ <xs:sequence maxOccurs="unbounded">
157
+ <xs:element name="SimpleType" type="fmi2SimpleType"/>
158
+ </xs:sequence>
159
+ </xs:complexType>
160
+ </xs:element>
161
+ <xs:element name="LogCategories" minOccurs="0">
162
+ <xs:annotation>
163
+ <xs:documentation>Log categories available in FMU</xs:documentation>
164
+ </xs:annotation>
165
+ <xs:complexType>
166
+ <xs:sequence maxOccurs="unbounded">
167
+ <xs:element name="Category">
168
+ <xs:complexType>
169
+ <xs:attribute name="name" type="xs:normalizedString" use="required">
170
+ <xs:annotation>
171
+ <xs:documentation>Name of Category element. "name" must be unique with respect to all other elements of the LogCategories list. Standardized names: "logEvents", "logSingularLinearSystems", "logNonlinearSystems", "logDynamicStateSelection", "logStatusWarning", "logStatusDiscard", "logStatusError", "logStatusFatal", "logStatusPending", "logAll"</xs:documentation>
172
+ </xs:annotation>
173
+ </xs:attribute>
174
+ <xs:attribute name="description" type="xs:string">
175
+ <xs:annotation>
176
+ <xs:documentation>Description of the log category</xs:documentation>
177
+ </xs:annotation>
178
+ </xs:attribute>
179
+ </xs:complexType>
180
+ </xs:element>
181
+ </xs:sequence>
182
+ </xs:complexType>
183
+ </xs:element>
184
+ <xs:element name="DefaultExperiment" minOccurs="0">
185
+ <xs:complexType>
186
+ <xs:attribute name="startTime" type="xs:double">
187
+ <xs:annotation>
188
+ <xs:documentation>Default start time of simulation</xs:documentation>
189
+ </xs:annotation>
190
+ </xs:attribute>
191
+ <xs:attribute name="stopTime" type="xs:double">
192
+ <xs:annotation>
193
+ <xs:documentation>Default stop time of simulation</xs:documentation>
194
+ </xs:annotation>
195
+ </xs:attribute>
196
+ <xs:attribute name="tolerance" type="xs:double">
197
+ <xs:annotation>
198
+ <xs:documentation>Default relative integration tolerance</xs:documentation>
199
+ </xs:annotation>
200
+ </xs:attribute>
201
+ <xs:attribute name="stepSize" type="xs:double">
202
+ <xs:annotation>
203
+ <xs:documentation>ModelExchange: Default step size for fixed step integrators.
204
+ CoSimulation: Preferred communicationStepSize.</xs:documentation>
205
+ </xs:annotation>
206
+ </xs:attribute>
207
+ </xs:complexType>
208
+ </xs:element>
209
+ <xs:element name="VendorAnnotations" type="fmi2Annotation" minOccurs="0">
210
+ <xs:annotation>
211
+ <xs:documentation>Tool specific data (ignored by other tools)</xs:documentation>
212
+ </xs:annotation>
213
+ </xs:element>
214
+ <xs:element name="ModelVariables">
215
+ <xs:annotation>
216
+ <xs:documentation>Ordered list of all variables (first definition has index = 1).</xs:documentation>
217
+ </xs:annotation>
218
+ <xs:complexType>
219
+ <xs:sequence maxOccurs="unbounded">
220
+ <xs:element name="ScalarVariable" type="fmi2ScalarVariable"/>
221
+ </xs:sequence>
222
+ </xs:complexType>
223
+ </xs:element>
224
+ <xs:element name="ModelStructure">
225
+ <xs:annotation>
226
+ <xs:documentation>Ordered lists of outputs, exposed state derivatives,
227
+ and the initial unknowns. Optionally, the functional
228
+ dependency of these variables can be defined.</xs:documentation>
229
+ </xs:annotation>
230
+ <xs:complexType>
231
+ <xs:sequence>
232
+ <xs:element name="Outputs" type="fmi2VariableDependency" minOccurs="0">
233
+ <xs:annotation>
234
+ <xs:documentation>Ordered list of all outputs. Exactly all variables with causality="output" must be in this list. The dependency definition holds for Continuous-Time and for Event Mode (ModelExchange) and for Communication Points (CoSimulation).</xs:documentation>
235
+ </xs:annotation>
236
+ </xs:element>
237
+ <xs:element name="Derivatives" type="fmi2VariableDependency" minOccurs="0">
238
+ <xs:annotation>
239
+ <xs:documentation>Ordered list of all exposed state derivatives (and therefore implicitely associated continuous-time states). Exactly all state derivatives of a ModelExchange FMU must be in this list. A CoSimulation FMU need not expose its state derivatives. If a model has dynamic state selection, introduce dummy state variables. The dependency definition holds for Continuous-Time and for Event Mode (ModelExchange) and for Communication Points (CoSimulation).</xs:documentation>
240
+ </xs:annotation>
241
+ </xs:element>
242
+ <xs:element name="InitialUnknowns" minOccurs="0">
243
+ <xs:annotation>
244
+ <xs:documentation>Ordered list of all exposed Unknowns in Initialization Mode. This list consists of all variables with (1) causality = "output" and (initial="approx" or calculated"), (2) causality = "calculatedParameter", and (3) all continuous-time states and all state derivatives (defined with element Derivatives from ModelStructure)with initial=("approx" or "calculated"). The resulting list is not allowed to have duplicates (e.g. if a state is also an output, it is included only once in the list). The Unknowns in this list must be ordered according to their ScalarVariable index (e.g. if for two variables A and B the ScalarVariable index of A is less than the index of B, then A must appear before B in InitialUnknowns).</xs:documentation>
245
+ </xs:annotation>
246
+ <xs:complexType>
247
+ <xs:sequence maxOccurs="unbounded">
248
+ <xs:element name="Unknown">
249
+ <xs:annotation>
250
+ <xs:documentation>Dependency of scalar Unknown from Knowns:
251
+ Unknown=f(Known_1, Known_2, ...).
252
+ The Knowns are "inputs",
253
+ "variables with initial=exact", and
254
+ "independent variable".</xs:documentation>
255
+ </xs:annotation>
256
+ <xs:complexType>
257
+ <xs:attribute name="index" type="xs:unsignedInt" use="required">
258
+ <xs:annotation>
259
+ <xs:documentation>ScalarVariable index of Unknown</xs:documentation>
260
+ </xs:annotation>
261
+ </xs:attribute>
262
+ <xs:attribute name="dependencies">
263
+ <xs:annotation>
264
+ <xs:documentation>Defines the dependency of the Unknown (directly or indirectly via auxiliary variables) on the Knowns in the Initialization Mode. If not present, it must be assumed that the Unknown depends on all Knowns. If present as empty list, the Unknown depends on none of the Knowns. Otherwise the Unknown depends on the Knowns defined by the given ScalarVariable indices. The indices are ordered according to size, starting with the smallest index.</xs:documentation>
265
+ </xs:annotation>
266
+ <xs:simpleType>
267
+ <xs:list itemType="xs:unsignedInt"/>
268
+ </xs:simpleType>
269
+ </xs:attribute>
270
+ <xs:attribute name="dependenciesKind">
271
+ <xs:annotation>
272
+ <xs:documentation>If not present, it must be assumed that the Unknown depends on the Knowns without a particular structure. Otherwise, the corresponding Known v enters the equation as:
273
+ = "dependent": no particular structure, f(v)
274
+ = "constant" : constant factor, c*v (only for Real variables)
275
+ If "dependenciesKind" is present, "dependencies" must be present and must have the same number of list elements.</xs:documentation>
276
+ </xs:annotation>
277
+ <xs:simpleType>
278
+ <xs:list>
279
+ <xs:simpleType>
280
+ <xs:restriction base="xs:normalizedString">
281
+ <xs:enumeration value="dependent"/>
282
+ <xs:enumeration value="constant"/>
283
+ <xs:enumeration value="fixed"/>
284
+ <xs:enumeration value="tunable"/>
285
+ <xs:enumeration value="discrete"/>
286
+ </xs:restriction>
287
+ </xs:simpleType>
288
+ </xs:list>
289
+ </xs:simpleType>
290
+ </xs:attribute>
291
+ </xs:complexType>
292
+ </xs:element>
293
+ </xs:sequence>
294
+ </xs:complexType>
295
+ </xs:element>
296
+ </xs:sequence>
297
+ </xs:complexType>
298
+ </xs:element>
299
+ </xs:sequence>
300
+ <xs:attribute name="fmiVersion" type="xs:normalizedString" use="required" fixed="2.0">
301
+ <xs:annotation>
302
+ <xs:documentation>Version of FMI (Clarification for FMI 2.0.2: for FMI 2.0.x revisions fmiVersion is defined as "2.0").</xs:documentation>
303
+ </xs:annotation>
304
+ </xs:attribute>
305
+ <xs:attribute name="modelName" type="xs:string" use="required">
306
+ <xs:annotation>
307
+ <xs:documentation>Class name of FMU, e.g. "A.B.C" (several FMU instances are possible)</xs:documentation>
308
+ </xs:annotation>
309
+ </xs:attribute>
310
+ <xs:attribute name="guid" type="xs:normalizedString" use="required">
311
+ <xs:annotation>
312
+ <xs:documentation>Fingerprint of xml-file content to verify that xml-file and C-functions are compatible to each other</xs:documentation>
313
+ </xs:annotation>
314
+ </xs:attribute>
315
+ <xs:attribute name="description" type="xs:string"/>
316
+ <xs:attribute name="author" type="xs:string"/>
317
+ <xs:attribute name="version" type="xs:normalizedString">
318
+ <xs:annotation>
319
+ <xs:documentation>Version of FMU, e.g., "1.4.1"</xs:documentation>
320
+ </xs:annotation>
321
+ </xs:attribute>
322
+ <xs:attribute name="copyright" type="xs:string">
323
+ <xs:annotation>
324
+ <xs:documentation>Information on intellectual property copyright for this FMU, such as “© MyCompany 2011“</xs:documentation>
325
+ </xs:annotation>
326
+ </xs:attribute>
327
+ <xs:attribute name="license" type="xs:string">
328
+ <xs:annotation>
329
+ <xs:documentation>Information on intellectual property licensing for this FMU, such as “BSD license”, "Proprietary", or "Public Domain"</xs:documentation>
330
+ </xs:annotation>
331
+ </xs:attribute>
332
+ <xs:attribute name="generationTool" type="xs:normalizedString"/>
333
+ <xs:attribute name="generationDateAndTime" type="xs:dateTime"/>
334
+ <xs:attribute name="variableNamingConvention" use="optional" default="flat">
335
+ <xs:simpleType>
336
+ <xs:restriction base="xs:normalizedString">
337
+ <xs:enumeration value="flat"/>
338
+ <xs:enumeration value="structured"/>
339
+ </xs:restriction>
340
+ </xs:simpleType>
341
+ </xs:attribute>
342
+ <xs:attribute name="numberOfEventIndicators" type="xs:unsignedInt"/>
343
+ </xs:complexType>
344
+ </xs:element>
345
+ </xs:schema>
fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ScalarVariable.xsd ADDED
@@ -0,0 +1,218 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
3
+ <xs:include schemaLocation="fmi2Annotation.xsd"/>
4
+ <xs:include schemaLocation="fmi2AttributeGroups.xsd"/>
5
+ <xs:annotation>
6
+ <xs:documentation>
7
+ Copyright(c) 2008-2011 MODELISAR consortium,
8
+ 2012-2022 Modelica Association Project "FMI".
9
+ All rights reserved.
10
+
11
+ This schema file is part of the FMI 2.0.4 standard.
12
+
13
+ This file is licensed by the copyright holders under the 2-Clause BSD License
14
+ (https://opensource.org/licenses/BSD-2-Clause):
15
+
16
+ ----------------------------------------------------------------------------
17
+ Redistribution and use in source and binary forms, with or without
18
+ modification, are permitted provided that the following conditions are met:
19
+
20
+ - Redistributions of source code must retain the above copyright notice,
21
+ this list of conditions and the following disclaimer.
22
+
23
+ - Redistributions in binary form must reproduce the above copyright notice,
24
+ this list of conditions and the following disclaimer in the documentation
25
+ and/or other materials provided with the distribution.
26
+
27
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29
+ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
31
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
34
+ OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
35
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
36
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
+ ----------------------------------------------------------------------------
39
+ </xs:documentation>
40
+ </xs:annotation>
41
+ <xs:complexType name="fmi2ScalarVariable">
42
+ <xs:annotation>
43
+ <xs:documentation>Properties of a scalar variable</xs:documentation>
44
+ </xs:annotation>
45
+ <xs:sequence>
46
+ <xs:choice>
47
+ <xs:element name="Real">
48
+ <xs:complexType>
49
+ <xs:attribute name="declaredType" type="xs:normalizedString">
50
+ <xs:annotation>
51
+ <xs:documentation>If present, name of type defined with TypeDefinitions / SimpleType providing defaults.</xs:documentation>
52
+ </xs:annotation>
53
+ </xs:attribute>
54
+ <xs:attributeGroup ref="fmi2RealAttributes"/>
55
+ <xs:attribute name="start" type="xs:double">
56
+ <xs:annotation>
57
+ <xs:documentation>Value before initialization, if initial=exact or approx.
58
+ max >= start >= min required</xs:documentation>
59
+ </xs:annotation>
60
+ </xs:attribute>
61
+ <xs:attribute name="derivative" type="xs:unsignedInt">
62
+ <xs:annotation>
63
+ <xs:documentation>If present, this variable is the derivative of variable with ScalarVariable index "derivative".</xs:documentation>
64
+ </xs:annotation>
65
+ </xs:attribute>
66
+ <xs:attribute name="reinit" type="xs:boolean" use="optional" default="false">
67
+ <xs:annotation>
68
+ <xs:documentation>Only for ModelExchange and if variable is a continuous-time state:
69
+ If true, state can be reinitialized at an event by the FMU
70
+ If false, state will never be reinitialized at an event by the FMU</xs:documentation>
71
+ </xs:annotation>
72
+ </xs:attribute>
73
+ </xs:complexType>
74
+ </xs:element>
75
+ <xs:element name="Integer">
76
+ <xs:complexType>
77
+ <xs:attribute name="declaredType" type="xs:normalizedString">
78
+ <xs:annotation>
79
+ <xs:documentation>If present, name of type defined with TypeDefinitions / SimpleType providing defaults.</xs:documentation>
80
+ </xs:annotation>
81
+ </xs:attribute>
82
+ <xs:attributeGroup ref="fmi2IntegerAttributes"/>
83
+ <xs:attribute name="start" type="xs:int">
84
+ <xs:annotation>
85
+ <xs:documentation>Value before initialization, if initial=exact or approx.
86
+ max >= start >= min required</xs:documentation>
87
+ </xs:annotation>
88
+ </xs:attribute>
89
+ </xs:complexType>
90
+ </xs:element>
91
+ <xs:element name="Boolean">
92
+ <xs:complexType>
93
+ <xs:attribute name="declaredType" type="xs:normalizedString">
94
+ <xs:annotation>
95
+ <xs:documentation>If present, name of type defined with TypeDefinitions / SimpleType providing defaults.</xs:documentation>
96
+ </xs:annotation>
97
+ </xs:attribute>
98
+ <xs:attribute name="start" type="xs:boolean">
99
+ <xs:annotation>
100
+ <xs:documentation>Value before initialization, if initial=exact or approx</xs:documentation>
101
+ </xs:annotation>
102
+ </xs:attribute>
103
+ </xs:complexType>
104
+ </xs:element>
105
+ <xs:element name="String">
106
+ <xs:complexType>
107
+ <xs:attribute name="declaredType" type="xs:normalizedString">
108
+ <xs:annotation>
109
+ <xs:documentation>If present, name of type defined with TypeDefinitions / SimpleType providing defaults.</xs:documentation>
110
+ </xs:annotation>
111
+ </xs:attribute>
112
+ <xs:attribute name="start" type="xs:string">
113
+ <xs:annotation>
114
+ <xs:documentation>Value before initialization, if initial=exact or approx</xs:documentation>
115
+ </xs:annotation>
116
+ </xs:attribute>
117
+ </xs:complexType>
118
+ </xs:element>
119
+ <xs:element name="Enumeration">
120
+ <xs:complexType>
121
+ <xs:attribute name="declaredType" type="xs:normalizedString" use="required">
122
+ <xs:annotation>
123
+ <xs:documentation>Name of type defined with TypeDefinitions / SimpleType </xs:documentation>
124
+ </xs:annotation>
125
+ </xs:attribute>
126
+ <xs:attribute name="quantity" type="xs:normalizedString"/>
127
+ <xs:attribute name="min" type="xs:int"/>
128
+ <xs:attribute name="max" type="xs:int">
129
+ <xs:annotation>
130
+ <xs:documentation>max >= min required</xs:documentation>
131
+ </xs:annotation>
132
+ </xs:attribute>
133
+ <xs:attribute name="start" type="xs:int">
134
+ <xs:annotation>
135
+ <xs:documentation>Value before initialization, if initial=exact or approx.
136
+ max >= start >= min required</xs:documentation>
137
+ </xs:annotation>
138
+ </xs:attribute>
139
+ </xs:complexType>
140
+ </xs:element>
141
+ </xs:choice>
142
+ <xs:element name="Annotations" type="fmi2Annotation" minOccurs="0">
143
+ <xs:annotation>
144
+ <xs:documentation>Additional data of the scalar variable, e.g., for the dialog menu or the graphical layout</xs:documentation>
145
+ </xs:annotation>
146
+ </xs:element>
147
+ </xs:sequence>
148
+ <xs:attribute name="name" type="xs:normalizedString" use="required">
149
+ <xs:annotation>
150
+ <xs:documentation>Identifier of variable, e.g. "a.b.mod[3,4].'#123'.c". "name" must be unique with respect to all other elements of the ModelVariables list</xs:documentation>
151
+ </xs:annotation>
152
+ </xs:attribute>
153
+ <xs:attribute name="valueReference" type="xs:unsignedInt" use="required">
154
+ <xs:annotation>
155
+ <xs:documentation>Identifier for variable value in FMI2 function calls (not necessarily unique with respect to all variables)</xs:documentation>
156
+ </xs:annotation>
157
+ </xs:attribute>
158
+ <xs:attribute name="description" type="xs:string"/>
159
+ <xs:attribute name="causality" default="local">
160
+ <xs:annotation>
161
+ <xs:documentation>parameter: independent parameter
162
+ calculatedParameter: calculated parameter
163
+ input/output: can be used in connections
164
+ local: variable calculated from other variables
165
+ independent: independent variable (usually time)</xs:documentation>
166
+ </xs:annotation>
167
+ <xs:simpleType>
168
+ <xs:restriction base="xs:normalizedString">
169
+ <xs:enumeration value="parameter"/>
170
+ <xs:enumeration value="calculatedParameter"/>
171
+ <xs:enumeration value="input"/>
172
+ <xs:enumeration value="output"/>
173
+ <xs:enumeration value="local"/>
174
+ <xs:enumeration value="independent"/>
175
+ </xs:restriction>
176
+ </xs:simpleType>
177
+ </xs:attribute>
178
+ <xs:attribute name="variability" default="continuous">
179
+ <xs:annotation>
180
+ <xs:documentation>constant: value never changes
181
+ fixed: value fixed after initialization
182
+ tunable: value constant between external events
183
+ discrete: value constant between internal events
184
+ continuous: no restriction on value changes</xs:documentation>
185
+ </xs:annotation>
186
+ <xs:simpleType>
187
+ <xs:restriction base="xs:normalizedString">
188
+ <xs:enumeration value="constant"/>
189
+ <xs:enumeration value="fixed"/>
190
+ <xs:enumeration value="tunable"/>
191
+ <xs:enumeration value="discrete"/>
192
+ <xs:enumeration value="continuous"/>
193
+ </xs:restriction>
194
+ </xs:simpleType>
195
+ </xs:attribute>
196
+ <xs:attribute name="initial">
197
+ <xs:annotation>
198
+ <xs:documentation>exact: initialized with start value
199
+ approx: iteration variable that starts with start value
200
+ calculated: calculated from other variables.
201
+ If not provided, initial is deduced from causality and variability (details see specification)</xs:documentation>
202
+ </xs:annotation>
203
+ <xs:simpleType>
204
+ <xs:restriction base="xs:normalizedString">
205
+ <xs:enumeration value="exact"/>
206
+ <xs:enumeration value="approx"/>
207
+ <xs:enumeration value="calculated"/>
208
+ </xs:restriction>
209
+ </xs:simpleType>
210
+ </xs:attribute>
211
+ <xs:attribute name="canHandleMultipleSetPerTimeInstant" type="xs:boolean">
212
+ <xs:annotation>
213
+ <xs:documentation>Only for ModelExchange and only for variables with variability = "input":
214
+ If present with value = false, then only one fmi2SetXXX call is allowed at one super dense time instant. In other words, this input is not allowed to appear in an algebraic loop.</xs:documentation>
215
+ </xs:annotation>
216
+ </xs:attribute>
217
+ </xs:complexType>
218
+ </xs:schema>