File: MonitoringModel.xsd

package info (click to toggle)
camitk 6.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 389,508 kB
  • sloc: cpp: 103,476; sh: 2,448; python: 1,618; xml: 984; makefile: 128; perl: 84; sed: 20
file content (275 lines) | stat: -rw-r--r-- 9,566 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

	<!--########################## Monitoring In ##########################-->

	<xsd:complexType name="MonitoringIn">
		<xsd:annotation>
		<xsd:documentation>
		monitoring model is a generic representation for monitors, simulation parameters and stopping criteria
		</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="dt" type="TimeParameter" minOccurs="1" maxOccurs="1"/>
			<xsd:element name="refresh" type="TimeParameter" minOccurs="1" maxOccurs="1"/>
			<xsd:choice>
				<xsd:element name="pmlFile" type="xsd:string" maxOccurs="1"/>
				<xsd:element name="simulatorFile" type="xsd:string" maxOccurs="1"/>
			</xsd:choice>
			<xsd:element name="lmlFile" type="xsd:string" minOccurs="0" maxOccurs="1"/>
			<xsd:element name="simulator" type="xsd:string" minOccurs="1" maxOccurs="1"/>
			<xsd:element name="stoppingCriteria" type="StoppingCriteria" minOccurs="0" maxOccurs="1"/>
			<xsd:element name="monitors" type="Monitors" minOccurs="0" maxOccurs="1"/>
			
		</xsd:sequence>
	</xsd:complexType>

	<xsd:complexType name="TimeParameter">
		<xsd:complexContent>
			<xsd:restriction base="xsd:anyType">
				<xsd:attribute name="value" type="xsd:double" use="required"/>
				<xsd:attribute name="unit" type="TimeUnit" use="required"/>
			</xsd:restriction>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:simpleType name="TimeUnit">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="ms"/>
			<xsd:enumeration value="s"/>
			<xsd:enumeration value="min"/>
		</xsd:restriction>
	</xsd:simpleType>

	<!--####### Stopping criteria #######-->

	<xsd:complexType name="StoppingCriteria">
		<xsd:choice>
			<xsd:element name="criteria" type="Criteria"/>
			<xsd:element name="multipleCriteria" type="MultipleCriteria"/>
		</xsd:choice>
	</xsd:complexType>

		<!--####### Criteria #######-->

    	<xsd:complexType name="Criteria" abstract="true">
		<xsd:sequence>
			<xsd:element name="method" type="Method"/>
			<xsd:element name="data" type="xsd:string" minOccurs="0"/>  <!-- only if used for outpout -->
		</xsd:sequence>
	</xsd:complexType>

	<xsd:complexType name="KineticEnergy">
		<xsd:complexContent>
			<xsd:extension base="Criteria">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:complexType name="Speed">
		<xsd:complexContent>
			<xsd:extension base="Criteria">
				<xsd:attribute name="unit" type="SpeedUnit" use="required"/>
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:simpleType name="SpeedUnit">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="m/s"/>
		</xsd:restriction>
	</xsd:simpleType>

	<xsd:complexType name="Position">
		<xsd:complexContent>
			<xsd:extension base="Criteria">
				<xsd:attribute name="unit" type="PositionUnit" use="required"/>
                <xsd:attribute name="target" type="xsd:string" use="optional"/>
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>
    	
    <xsd:simpleType name="PositionUnit">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="nm"/>
			<xsd:enumeration value="mm"/>
		</xsd:restriction>
	</xsd:simpleType>

	<xsd:complexType name="Time">
		<xsd:complexContent>
			<xsd:extension base="Criteria">
				<xsd:attribute name="unit" type="TimeUnit" use="required"/>
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:complexType name="Force">
		<xsd:complexContent>
			<xsd:extension base="Criteria">
				<xsd:attribute name="unit" type="ForceUnit" use="required"/>
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:simpleType name="ForceUnit">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="mN"/>
			<xsd:enumeration value="N"/>
		</xsd:restriction>
	</xsd:simpleType>

	<xsd:complexType name="Method" abstract="true">
		<xsd:attribute name="scope" type="Scope"/> <!-- default value?... -->
	</xsd:complexType>

	<xsd:complexType name="Threshold">
		<xsd:complexContent>
			<xsd:extension base="Method">
				<xsd:attribute name="maxValue" type="xsd:double" use="required"/>
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>
    
    <xsd:complexType name="TimePeriodThreshold">
        <xsd:complexContent>
            <xsd:extension base="Method">
                <xsd:attribute name="minValue" type="xsd:double" use="required"/>
                <xsd:attribute name="iterations" type="xsd:int" use="required"/>
            </xsd:extension>
        </xsd:complexContent>
    </xsd:complexType>
    
        <xsd:complexType name="MinThreshold">
          <xsd:complexContent>
            <xsd:extension base="Method">
              <xsd:attribute name="minValue" type="xsd:double" use="required"/>
            </xsd:extension>
          </xsd:complexContent>
        </xsd:complexType>

        <xsd:simpleType name="Scope">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="Any"/>
			<xsd:enumeration value="Average"/>
			<xsd:enumeration value="Sum"/>
		</xsd:restriction>
	</xsd:simpleType>

		<!--####### Multiple Criteria #######-->

	<xsd:complexType name="MultipleCriteria">
		<xsd:choice minOccurs="2" maxOccurs="unbounded">
			<xsd:element  name="multipleCriteria" type="MultipleCriteria"/>
			<xsd:element  name="criteria" type="Criteria"/>
		</xsd:choice>
		<xsd:attribute name="op" type="LogicalOp" use="required"/>
	</xsd:complexType>

	<xsd:simpleType name="LogicalOp">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="And"/>
			<xsd:enumeration value="Or"/>
		</xsd:restriction>
	</xsd:simpleType>

	<!--####### Monitors #######-->

	<xsd:complexType name="Monitors">
		<xsd:sequence>
			<xsd:element name="monitor" type="Monitor" maxOccurs="unbounded"/>
		</xsd:sequence>
	</xsd:complexType>
	
	<xsd:complexType name="Reference">
		<xsd:complexContent>
			<xsd:restriction base="xsd:anyType">
				<xsd:attribute name="document" type="xsd:string" use="required"/>
				<xsd:attribute name="monitorIndex" type="xsd:nonNegativeInteger"/>
				<xsd:attribute name="target" type="xsd:string"/>
			</xsd:restriction>
		</xsd:complexContent>
	</xsd:complexType>

	<xsd:complexType name="Monitor">
		<xsd:sequence>
			<xsd:element name="startAt" type="TimeParameter"/>
			<xsd:element name="stopAt" type="TimeParameter"/>
			<xsd:element name="reference" type="Reference" minOccurs="0" maxOccurs="2" />
			<xsd:element name="indexes" type="xsd:string" minOccurs="0"/>  <!-- only if used for output -->
			<xsd:element name="data" type="xsd:string" minOccurs="0"/>  <!-- only if used for output -->
			
		</xsd:sequence>
		<xsd:attribute name="type" type="MonitorType" use="required"/>
		<xsd:attribute name="index" type="xsd:nonNegativeInteger" use="required"/>
		<xsd:attribute name="target" type="xsd:string" use="required"/>
		<xsd:attribute name="dx" type="xsd:double"/>
		<xsd:attribute name="dy" type="xsd:double"/>
		<xsd:attribute name="dz" type="xsd:double"/>
	</xsd:complexType>

	<xsd:simpleType name="MonitorType">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="Position"/>
			<xsd:enumeration value="REN"/>
			<xsd:enumeration value="GeomDeviation"/>	
			<xsd:enumeration value="Force"/>
			<xsd:enumeration value="PointSetDistance"/>
			<xsd:enumeration value="PointFinalSetDistance"/>
			<xsd:enumeration value="Volume"/>
			<xsd:enumeration value="Surface"/>
			<xsd:enumeration value="Displacement"/>
			<xsd:enumeration value="NormDisplacement"/>
			<xsd:enumeration value="DistanceToTriangularMeshFinal"/>
			<xsd:enumeration value="ComputingTime"/>
			<xsd:enumeration value="DistanceX"/>
			<xsd:enumeration value="DistanceY"/>
			<xsd:enumeration value="DistanceZ"/>	
		</xsd:restriction>
	</xsd:simpleType>

	<!--########################## Monitoring Out ##########################-->

	<xsd:complexType name="MonitoringOut">
		<xsd:sequence>
			<xsd:element name="pmlFile" type="xsd:string" minOccurs="1" maxOccurs="1"/>
			<xsd:element name="time" type="TimeStep" maxOccurs="unbounded"/>
		</xsd:sequence>
	</xsd:complexType>

	<xsd:complexType name="TimeStep">
		<xsd:sequence>
			<xsd:element name="stoppingCriteria" type="StoppingCriteria" minOccurs="0" maxOccurs="1"/>
			<xsd:element name="monitor" type="Monitor" minOccurs="0" maxOccurs="unbounded"/>
		</xsd:sequence>
		<xsd:attribute name="value" type="xsd:double" use="required"/>
		<xsd:attribute name="unit" type="TimeUnit" use="required"/>
	</xsd:complexType>

</xsd:schema>