libcamitk4-doc 4.0.4-2 / usr / share / camitk-4.0 / apidoc / html / classStructureProperties.html

This file is indexed.

/usr/share/camitk-4.0/apidoc/html/classStructureProperties.html is in libcamitk4-doc 4.0.4-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Computer Assited Medical Intervention Tool Kit: StructureProperties Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="camitk-small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Computer Assited Medical Intervention Tool Kit
   &#160;<span id="projectnumber">version 4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classStructureProperties-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">StructureProperties Class Reference<div class="ingroups"><a class="el" href="group__group__cepmodeling.html">CEP Modeling</a> &raquo; <a class="el" href="group__group__cepmodeling__libraries.html">Libraries</a> &raquo; <a class="el" href="group__group__cepmodeling__libraries__pml.html">PML</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Describes the properties common to all structures.  
 <a href="classStructureProperties.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="StructureProperties_8h_source.html">StructureProperties.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="classProperties.html">Properties</a>.</p>

<p>Inherited by <a class="el" href="classAtomProperties.html">AtomProperties</a>, and <a class="el" href="classCellProperties.html">CellProperties</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9180a07ccc47844f526e879201d75731"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a> { <br />
&#160;&#160;<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a606927b36de060292ab110c0ffb8fda6">INVALID</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a10a947ffcd63f50787f75a33f512f2b1">ATOM</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a4e649a65336a327b2b6a38e937d6e26d">LINE</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731aafad539f241ab0931a414284f3658974">TRIANGLE</a>, 
<br />
&#160;&#160;<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a70cd9e366650ca00912d1cbe9b61eca2">QUAD</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a97b9c987bb76cf4e7cc9c0a0aa4704ce">TETRAHEDRON</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a74a53207505536ceb0ad64733d2a8a0b">WEDGE</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ae55eaaa4a01ee2d554c70f2e785231bf">PYRAMID</a>, 
<br />
&#160;&#160;<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a1e936c531a196f8454c3a10bb7841e80">HEXAHEDRON</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a05442bd0a1696fd9414348c072a805df">POLY_LINE</a>, 
<a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ac6bd3ea86bc8cff47b41e36049649f96">POLY_VERTEX</a>
<br />
 }<tr class="memdesc:a9180a07ccc47844f526e879201d75731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Geometric type gives information about which kind of geometric representation is the structure.  <a href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a9180a07ccc47844f526e879201d75731"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a16b161b8e59a9ed15acd713baf4cde18"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a16b161b8e59a9ed15acd713baf4cde18">getIndex</a> () const</td></tr>
<tr class="memdesc:a16b161b8e59a9ed15acd713baf4cde18"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the unique index in the global structure  <a href="#a16b161b8e59a9ed15acd713baf4cde18">More...</a><br /></td></tr>
<tr class="separator:a16b161b8e59a9ed15acd713baf4cde18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a424fa864b33071bff1e23a9dc8166ebd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a424fa864b33071bff1e23a9dc8166ebd">getType</a> () const</td></tr>
<tr class="memdesc:a424fa864b33071bff1e23a9dc8166ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the type of force.  <a href="#a424fa864b33071bff1e23a9dc8166ebd">More...</a><br /></td></tr>
<tr class="separator:a424fa864b33071bff1e23a9dc8166ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a989758e97c3249b5e8f769b353e8aefe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a989758e97c3249b5e8f769b353e8aefe">setIndex</a> (const unsigned int)</td></tr>
<tr class="memdesc:a989758e97c3249b5e8f769b353e8aefe"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the index (BECAREFUL: it MUST be unique !!!)  <a href="#a989758e97c3249b5e8f769b353e8aefe">More...</a><br /></td></tr>
<tr class="separator:a989758e97c3249b5e8f769b353e8aefe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c64143e52b2e5239c87343a888a918d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a8c64143e52b2e5239c87343a888a918d">setType</a> (const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a> t)</td></tr>
<tr class="memdesc:a8c64143e52b2e5239c87343a888a918d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the force type.  <a href="#a8c64143e52b2e5239c87343a888a918d">More...</a><br /></td></tr>
<tr class="separator:a8c64143e52b2e5239c87343a888a918d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dde5d5125630493e80625b0ebd5d90b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a0dde5d5125630493e80625b0ebd5d90b">StructureProperties</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *, const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>)</td></tr>
<tr class="memdesc:a0dde5d5125630493e80625b0ebd5d90b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the only default constructor : type must be set  <a href="#a0dde5d5125630493e80625b0ebd5d90b">More...</a><br /></td></tr>
<tr class="separator:a0dde5d5125630493e80625b0ebd5d90b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10ecb29467c2d7a9cc61c00cc08c6470"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a10ecb29467c2d7a9cc61c00cc08c6470">xmlPrint</a> (std::ostream &amp;) const</td></tr>
<tr class="memdesc:a10ecb29467c2d7a9cc61c00cc08c6470"><td class="mdescLeft">&#160;</td><td class="mdescRight">print to an output stream in "pseaudo" XML format.  <a href="#a10ecb29467c2d7a9cc61c00cc08c6470">More...</a><br /></td></tr>
<tr class="separator:a10ecb29467c2d7a9cc61c00cc08c6470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6edaa28c6ced40e3e7b2fc3f19be7a5a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties</a> ()</td></tr>
<tr class="separator:a6edaa28c6ced40e3e7b2fc3f19be7a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classProperties"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classProperties')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classProperties.html">Properties</a></td></tr>
<tr class="memitem:a20a68139af83de00e989198387927200 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a20a68139af83de00e989198387927200">getName</a> () const</td></tr>
<tr class="memdesc:a20a68139af83de00e989198387927200 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the name (be careful, this method DOES NOT return a copy, so you got the direct ptr to the name!!!)  <a href="classProperties.html#a20a68139af83de00e989198387927200">More...</a><br /></td></tr>
<tr class="separator:a20a68139af83de00e989198387927200 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a316aad45126d00309435baa16037c524 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a316aad45126d00309435baa16037c524">getPhysicalModel</a> () const</td></tr>
<tr class="memdesc:a316aad45126d00309435baa16037c524 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the physical model  <a href="classProperties.html#a316aad45126d00309435baa16037c524">More...</a><br /></td></tr>
<tr class="separator:a316aad45126d00309435baa16037c524 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a193c759907ba3e29799aa3f28fd8c868 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a193c759907ba3e29799aa3f28fd8c868">Properties</a> (const std::string n=&quot;&quot;)</td></tr>
<tr class="memdesc:a193c759907ba3e29799aa3f28fd8c868 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">A nice simple constructor, with a given name.  <a href="classProperties.html#a193c759907ba3e29799aa3f28fd8c868">More...</a><br /></td></tr>
<tr class="separator:a193c759907ba3e29799aa3f28fd8c868 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6252bf62817cb2ae09efdfe03fe93d0f inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a6252bf62817cb2ae09efdfe03fe93d0f">Properties</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *, const std::string n=&quot;&quot;)</td></tr>
<tr class="memdesc:a6252bf62817cb2ae09efdfe03fe93d0f inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">Another nice constructor, with the PM and a name.  <a href="classProperties.html#a6252bf62817cb2ae09efdfe03fe93d0f">More...</a><br /></td></tr>
<tr class="separator:a6252bf62817cb2ae09efdfe03fe93d0f inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a630adc42d8a4bd88d2ae7f8f527bf83e inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a630adc42d8a4bd88d2ae7f8f527bf83e">setName</a> (std::string)</td></tr>
<tr class="memdesc:a630adc42d8a4bd88d2ae7f8f527bf83e inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the name (use the string = operator)  <a href="classProperties.html#a630adc42d8a4bd88d2ae7f8f527bf83e">More...</a><br /></td></tr>
<tr class="separator:a630adc42d8a4bd88d2ae7f8f527bf83e inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7ad08175ea758b6beab31d4aa6f5b8b inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#ab7ad08175ea758b6beab31d4aa6f5b8b">setPhysicalModel</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *)</td></tr>
<tr class="memdesc:ab7ad08175ea758b6beab31d4aa6f5b8b inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the physical model  <a href="classProperties.html#ab7ad08175ea758b6beab31d4aa6f5b8b">More...</a><br /></td></tr>
<tr class="separator:ab7ad08175ea758b6beab31d4aa6f5b8b inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a4367c64d90a962fc260128587670dd inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a9a4367c64d90a962fc260128587670dd">~Properties</a> ()</td></tr>
<tr class="memdesc:a9a4367c64d90a962fc260128587670dd inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default destructor.  <a href="classProperties.html#a9a4367c64d90a962fc260128587670dd">More...</a><br /></td></tr>
<tr class="separator:a9a4367c64d90a962fc260128587670dd inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6770198ffedb2a221f5b7d28bfc902a0 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a6770198ffedb2a221f5b7d28bfc902a0">xmlToFields</a> (xsd::cxx::tree::attribute_set&lt; char &gt; attrs)</td></tr>
<tr class="memdesc:a6770198ffedb2a221f5b7d28bfc902a0 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert the xml node parameters to data fields  <a href="classProperties.html#a6770198ffedb2a221f5b7d28bfc902a0">More...</a><br /></td></tr>
<tr class="separator:a6770198ffedb2a221f5b7d28bfc902a0 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a333801e00b87b115736fc10a7e81e6 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a6a333801e00b87b115736fc10a7e81e6">numberOfFields</a> () const</td></tr>
<tr class="memdesc:a6a333801e00b87b115736fc10a7e81e6 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the number of extra fields found in the PML  <a href="classProperties.html#a6a333801e00b87b115736fc10a7e81e6">More...</a><br /></td></tr>
<tr class="separator:a6a333801e00b87b115736fc10a7e81e6 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2136bc1d10507282867bf69fa0a1b8ce inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a2136bc1d10507282867bf69fa0a1b8ce">isAField</a> (std::string attName) const</td></tr>
<tr class="memdesc:a2136bc1d10507282867bf69fa0a1b8ce inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">check if the field exist in the XML document, return false if it does not  <a href="classProperties.html#a2136bc1d10507282867bf69fa0a1b8ce">More...</a><br /></td></tr>
<tr class="separator:a2136bc1d10507282867bf69fa0a1b8ce inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf1738fdbe4c37d2c25c9d54a21a636 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#aadf1738fdbe4c37d2c25c9d54a21a636">getField</a> (unsigned int) const</td></tr>
<tr class="memdesc:aadf1738fdbe4c37d2c25c9d54a21a636 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the name of field of given index  <a href="classProperties.html#aadf1738fdbe4c37d2c25c9d54a21a636">More...</a><br /></td></tr>
<tr class="separator:aadf1738fdbe4c37d2c25c9d54a21a636 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0217383f4dfbc5a8b50c7ab62eb7cc64 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a0217383f4dfbc5a8b50c7ab62eb7cc64">getDouble</a> (std::string attName)</td></tr>
<tr class="memdesc:a0217383f4dfbc5a8b50c7ab62eb7cc64 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field accessor: get the field attName as a double value, if field does not exist, 0.0 is return  <a href="classProperties.html#a0217383f4dfbc5a8b50c7ab62eb7cc64">More...</a><br /></td></tr>
<tr class="separator:a0217383f4dfbc5a8b50c7ab62eb7cc64 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b29f37b03a9682783009bf93459f5aa inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a7b29f37b03a9682783009bf93459f5aa">getInt</a> (std::string attName) const</td></tr>
<tr class="memdesc:a7b29f37b03a9682783009bf93459f5aa inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field accessor: get the field attName as an int value, if field does not exist, 0 is return  <a href="classProperties.html#a7b29f37b03a9682783009bf93459f5aa">More...</a><br /></td></tr>
<tr class="separator:a7b29f37b03a9682783009bf93459f5aa inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98f7563c1f15ac71394d49f261020369 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a98f7563c1f15ac71394d49f261020369">getBool</a> (std::string attName) const</td></tr>
<tr class="memdesc:a98f7563c1f15ac71394d49f261020369 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field accessor: get the field attName as a bool value, if field does not exist, false is return  <a href="classProperties.html#a98f7563c1f15ac71394d49f261020369">More...</a><br /></td></tr>
<tr class="separator:a98f7563c1f15ac71394d49f261020369 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a48d3d852b712e5b83d03235923f3b1 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a3a48d3d852b712e5b83d03235923f3b1">getString</a> (std::string attName) const</td></tr>
<tr class="memdesc:a3a48d3d852b712e5b83d03235923f3b1 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field accessor: get the field attName as a string value, if field does not exist, empty string is return  <a href="classProperties.html#a3a48d3d852b712e5b83d03235923f3b1">More...</a><br /></td></tr>
<tr class="separator:a3a48d3d852b712e5b83d03235923f3b1 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80aac92260685f2dcfbdf7e91526b3a inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#ae80aac92260685f2dcfbdf7e91526b3a">get</a> (std::string attName, std::string &amp;attVal) const</td></tr>
<tr class="memdesc:ae80aac92260685f2dcfbdf7e91526b3a inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field accessor: get the field attName as a string value in attVal, if field does not exist, empty string is return  <a href="classProperties.html#ae80aac92260685f2dcfbdf7e91526b3a">More...</a><br /></td></tr>
<tr class="separator:ae80aac92260685f2dcfbdf7e91526b3a inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4415265831f28d7805120e2316935ca1 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a4415265831f28d7805120e2316935ca1">set</a> (std::string attName, double val)</td></tr>
<tr class="memdesc:a4415265831f28d7805120e2316935ca1 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field modificator: set field attName using a double value  <a href="classProperties.html#a4415265831f28d7805120e2316935ca1">More...</a><br /></td></tr>
<tr class="separator:a4415265831f28d7805120e2316935ca1 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b9961582e5eb0136ba436cbce7eb9dd inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a7b9961582e5eb0136ba436cbce7eb9dd">set</a> (std::string attName, int val)</td></tr>
<tr class="memdesc:a7b9961582e5eb0136ba436cbce7eb9dd inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field modificator: set field attName using an int value  <a href="classProperties.html#a7b9961582e5eb0136ba436cbce7eb9dd">More...</a><br /></td></tr>
<tr class="separator:a7b9961582e5eb0136ba436cbce7eb9dd inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae250ed77e6a1dad9510247936b13ba57 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#ae250ed77e6a1dad9510247936b13ba57">set</a> (std::string attName, bool val)</td></tr>
<tr class="memdesc:ae250ed77e6a1dad9510247936b13ba57 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field modificator: set field attName using a bool value  <a href="classProperties.html#ae250ed77e6a1dad9510247936b13ba57">More...</a><br /></td></tr>
<tr class="separator:ae250ed77e6a1dad9510247936b13ba57 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e6e235fbfcfecc1d2ba8c8822514855 inherit pub_methods_classProperties"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a0e6e235fbfcfecc1d2ba8c8822514855">set</a> (std::string attName, std::string val)</td></tr>
<tr class="memdesc:a0e6e235fbfcfecc1d2ba8c8822514855 inherit pub_methods_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">field modificator: set field attName using a string value  <a href="classProperties.html#a0e6e235fbfcfecc1d2ba8c8822514855">More...</a><br /></td></tr>
<tr class="separator:a0e6e235fbfcfecc1d2ba8c8822514855 inherit pub_methods_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aadba0e47b44280cd0aa2140542acc0c5"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#aadba0e47b44280cd0aa2140542acc0c5">toString</a> (const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>)</td></tr>
<tr class="memdesc:aadba0e47b44280cd0aa2140542acc0c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the string equivalent to this geometric type  <a href="#aadba0e47b44280cd0aa2140542acc0c5">More...</a><br /></td></tr>
<tr class="separator:aadba0e47b44280cd0aa2140542acc0c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf21ca15b9f355e73d10b4700af9405d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#acf21ca15b9f355e73d10b4700af9405d">toType</a> (const std::string)</td></tr>
<tr class="memdesc:acf21ca15b9f355e73d10b4700af9405d"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the enum corresponding to this string  <a href="#acf21ca15b9f355e73d10b4700af9405d">More...</a><br /></td></tr>
<tr class="separator:acf21ca15b9f355e73d10b4700af9405d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aede0af0788fcc531cca23ff730306b62"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#aede0af0788fcc531cca23ff730306b62">index</a></td></tr>
<tr class="memdesc:aede0af0788fcc531cca23ff730306b62"><td class="mdescLeft">&#160;</td><td class="mdescRight">unique index in the global structure  <a href="#aede0af0788fcc531cca23ff730306b62">More...</a><br /></td></tr>
<tr class="separator:aede0af0788fcc531cca23ff730306b62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classProperties"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classProperties')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classProperties.html">Properties</a></td></tr>
<tr class="memitem:a9db1af2b4dd5aa97e4941e533592ceb8 inherit pro_attribs_classProperties"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classProperties.html#a9db1af2b4dd5aa97e4941e533592ceb8">fields</a></td></tr>
<tr class="memdesc:a9db1af2b4dd5aa97e4941e533592ceb8 inherit pro_attribs_classProperties"><td class="mdescLeft">&#160;</td><td class="mdescRight">map containing all the different fields (name, value stored as string )  <a href="classProperties.html#a9db1af2b4dd5aa97e4941e533592ceb8">More...</a><br /></td></tr>
<tr class="separator:a9db1af2b4dd5aa97e4941e533592ceb8 inherit pro_attribs_classProperties"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a3af910533e21bc25e38bc9b39b9de9be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStructureProperties.html#a3af910533e21bc25e38bc9b39b9de9be">type</a></td></tr>
<tr class="memdesc:a3af910533e21bc25e38bc9b39b9de9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">The geometric type,.  <a href="#a3af910533e21bc25e38bc9b39b9de9be">More...</a><br /></td></tr>
<tr class="separator:a3af910533e21bc25e38bc9b39b9de9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes the properties common to all structures. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a9180a07ccc47844f526e879201d75731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9180a07ccc47844f526e879201d75731">&#9670;&nbsp;</a></span>GeometricType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">StructureProperties::GeometricType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Geometric type gives information about which kind of geometric representation is the structure. </p>
<p>For 3D geometric shapes, atoms have to be given in a proper order:</p>
<pre>
TRIANGLE
      2           lines:
    /  \          0,1
   /    \         0,2
  0---&mdash;1        1,2</pre><pre>QUAD
  3-----&mdash;2      lines:
  |        |      0,1
  |        |      1,2
  |        |      2,3
  0-----&mdash;1      3,0</pre><pre>TETRAHEDRON
      3
    /| \          facets (triangles):      lines:
   / |  \         0,1,2 (base)             0,1
  1..|... 2      0,2,3                    0,2
  \  |   /        0,3,1                    0,3
   \ |  /         2,1,3                    1,2
    |/                                    1,3
     0                                     2,3</pre><pre>PYRAMID
<pre class="fragment">               4
              ,/|\
            ,/ .'|\                        (copied from gmsh documentation)
          ,/   | | \
        ,/    .' | `.
      ,/      |  '.  \
    ,/       .' w |   \
  ,/         |  ^ |    \
 0----------.'--|-3    `.
  `\        |   |  `\    \
    `\     .'   +----`\ - \ -&gt; v
      `\   |    `\     `\  \
        `\.'      `\     `\`
           1----------------2
                     `\
                        u
</pre></pre><pre>WEDGE
     1----------&mdash;4       facets (quad):   facets (triangles):     lines:
    /\           . \       2,5,4,1          0,2,1                   0,1      2,5
   /  \         /   \      0,1,4,3          3,4,5                   0,2      3,4
  0- - \ - - - 3     \     2,0,3,5                                  1,2      4,5
    \   \         \   \                                             0,3      5,3
      \ 2--------&mdash;--5                                            1,4</pre><pre>HEXAHEDRON
     2----------&mdash;6       facets (quad):         lines:
    / \           . \      0,3,2,1                0,1     6,7
   /   \         /   \     0,4,7,3                1,2     7,4
  1- - -\ - - - 5     \    0,1,5,4                2,3     0,4
  \     3----------&mdash;7    3,7,6,2                3,0     1,5
   \   /         \   /     1,2,6,5                4,5     2,6
    \ /           . /      4,5,6,7                5,6     3,7
     0----------&mdash;4</pre><pre></pre> <table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a606927b36de060292ab110c0ffb8fda6"></a>INVALID&#160;</td><td class="fielddoc"><p>invalid geometry type </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a10a947ffcd63f50787f75a33f512f2b1"></a>ATOM&#160;</td><td class="fielddoc"><p>the structure is an atom, and hence should be represented by a single point </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a4e649a65336a327b2b6a38e937d6e26d"></a>LINE&#160;</td><td class="fielddoc"><p>the structure is a simple line, i.e it must be a cell composed of only 2 atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731aafad539f241ab0931a414284f3658974"></a>TRIANGLE&#160;</td><td class="fielddoc"><p>the structure is a triangle, i.e it must be a cell composed of 3 atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a70cd9e366650ca00912d1cbe9b61eca2"></a>QUAD&#160;</td><td class="fielddoc"><p>the structure is a quad, i.e it must be a cell composed of 4 atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a97b9c987bb76cf4e7cc9c0a0aa4704ce"></a>TETRAHEDRON&#160;</td><td class="fielddoc"><p>the structure is a tetrahedron, it must be a cell and have sub-structures that are atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a74a53207505536ceb0ad64733d2a8a0b"></a>WEDGE&#160;</td><td class="fielddoc"><p>the structure is a wedge (like the Pink Floyd's "Dark Side Of the Moon" prism), it must be a cell and have sub-structures that are atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731ae55eaaa4a01ee2d554c70f2e785231bf"></a>PYRAMID&#160;</td><td class="fielddoc"><p>the structure has a quad base and one vertex outside the defined base plane (like an egyptian pyramid!) </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a1e936c531a196f8454c3a10bb7841e80"></a>HEXAHEDRON&#160;</td><td class="fielddoc"><p>the structure is a hexahedron, it must be a cell and have sub-structures that are atoms </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731a05442bd0a1696fd9414348c072a805df"></a>POLY_LINE&#160;</td><td class="fielddoc"><p>the structure is a polyline, i.e it must be a cell and the order of the atom in the cell are arranged along a line </p>
</td></tr>
<tr><td class="fieldname"><a id="a9180a07ccc47844f526e879201d75731ac6bd3ea86bc8cff47b41e36049649f96"></a>POLY_VERTEX&#160;</td><td class="fielddoc"><p>the structure is a poly vertex, i.e it must be a cell and it is a point clouds </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0dde5d5125630493e80625b0ebd5d90b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dde5d5125630493e80625b0ebd5d90b">&#9670;&nbsp;</a></span>StructureProperties()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StructureProperties::StructureProperties </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> *&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td>
          <td class="paramname"><em>t</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the only default constructor : type must be set </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#a3af910533e21bc25e38bc9b39b9de9be">type</a>.</p>

</div>
</div>
<a id="a6edaa28c6ced40e3e7b2fc3f19be7a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6edaa28c6ced40e3e7b2fc3f19be7a5a">&#9670;&nbsp;</a></span>~StructureProperties()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual StructureProperties::~StructureProperties </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">References <a class="el" href="classStructureProperties.html#a16b161b8e59a9ed15acd713baf4cde18">getIndex()</a>, <a class="el" href="classStructureProperties.html#a424fa864b33071bff1e23a9dc8166ebd">getType()</a>, <a class="el" href="classStructureProperties.html#a989758e97c3249b5e8f769b353e8aefe">setIndex()</a>, <a class="el" href="classStructureProperties.html#a8c64143e52b2e5239c87343a888a918d">setType()</a>, and <a class="el" href="classStructureProperties.html#a10ecb29467c2d7a9cc61c00cc08c6470">xmlPrint()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a16b161b8e59a9ed15acd713baf4cde18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16b161b8e59a9ed15acd713baf4cde18">&#9670;&nbsp;</a></span>getIndex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int StructureProperties::getIndex </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>return the unique index in the global structure </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#aede0af0788fcc531cca23ff730306b62">index</a>.</p>

<p class="reference">Referenced by <a class="el" href="classStructure.html#a04b2fc52d7cc2af4356620f1d7e09c18">Structure::getIndex()</a>, and <a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties()</a>.</p>

</div>
</div>
<a id="a424fa864b33071bff1e23a9dc8166ebd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a424fa864b33071bff1e23a9dc8166ebd">&#9670;&nbsp;</a></span>getType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">StructureProperties::GeometricType</a> StructureProperties::getType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the type of force. </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#a3af910533e21bc25e38bc9b39b9de9be">type</a>.</p>

<p class="reference">Referenced by <a class="el" href="classPMLExplorerWidget.html#a0c6892e76e96a5e12c81fda6c6c9db2a">PMLExplorerWidget::createCellPropertyList()</a>, <a class="el" href="classReference.html#aa617c2c9b8f0a034fd8bdd944fe0b24e">Reference::getDistanceToTriangularMesh()</a>, <a class="el" href="classStructure.html#a8fd619e1b2635bd473bf182d0528f9c7">Structure::getType()</a>, <a class="el" href="classCellProperties.html#a16b6ea7c9f0afbdd7f2c1b5b9fd13575">CellProperties::xmlPrint()</a>, and <a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties()</a>.</p>

</div>
</div>
<a id="a989758e97c3249b5e8f769b353e8aefe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989758e97c3249b5e8f769b353e8aefe">&#9670;&nbsp;</a></span>setIndex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StructureProperties::setIndex </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&#160;</td>
          <td class="paramname"><em>newIndex</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>set the index (BECAREFUL: it MUST be unique !!!) </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#aede0af0788fcc531cca23ff730306b62">index</a>.</p>

<p class="reference">Referenced by <a class="el" href="classAtomProperties.html#a6ef5eed524f652885d997344084f9148">AtomProperties::AtomProperties()</a>, <a class="el" href="classStructure.html#afd2e8e677876ca72829350653597b83b">Structure::setIndex()</a>, and <a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties()</a>.</p>

</div>
</div>
<a id="a8c64143e52b2e5239c87343a888a918d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c64143e52b2e5239c87343a888a918d">&#9670;&nbsp;</a></span>setType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StructureProperties::setType </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the force type. </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#a3af910533e21bc25e38bc9b39b9de9be">type</a>.</p>

<p class="reference">Referenced by <a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties()</a>.</p>

</div>
</div>
<a id="aadba0e47b44280cd0aa2140542acc0c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadba0e47b44280cd0aa2140542acc0c5">&#9670;&nbsp;</a></span>toString()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string StructureProperties::toString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a>&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>return the string equivalent to this geometric type </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a10a947ffcd63f50787f75a33f512f2b1">ATOM</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a1e936c531a196f8454c3a10bb7841e80">HEXAHEDRON</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a4e649a65336a327b2b6a38e937d6e26d">LINE</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a05442bd0a1696fd9414348c072a805df">POLY_LINE</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ac6bd3ea86bc8cff47b41e36049649f96">POLY_VERTEX</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ae55eaaa4a01ee2d554c70f2e785231bf">PYRAMID</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a70cd9e366650ca00912d1cbe9b61eca2">QUAD</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a97b9c987bb76cf4e7cc9c0a0aa4704ce">TETRAHEDRON</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731aafad539f241ab0931a414284f3658974">TRIANGLE</a>, and <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a74a53207505536ceb0ad64733d2a8a0b">WEDGE</a>.</p>

<p class="reference">Referenced by <a class="el" href="classPMLExplorerWidget.html#a0c6892e76e96a5e12c81fda6c6c9db2a">PMLExplorerWidget::createCellPropertyList()</a>, and <a class="el" href="classStructureProperties.html#a10ecb29467c2d7a9cc61c00cc08c6470">xmlPrint()</a>.</p>

</div>
</div>
<a id="acf21ca15b9f355e73d10b4700af9405d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf21ca15b9f355e73d10b4700af9405d">&#9670;&nbsp;</a></span>toType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">StructureProperties::GeometricType</a> StructureProperties::toType </td>
          <td>(</td>
          <td class="paramtype">const std::string&#160;</td>
          <td class="paramname"><em>t</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>return the enum corresponding to this string </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a10a947ffcd63f50787f75a33f512f2b1">ATOM</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a1e936c531a196f8454c3a10bb7841e80">HEXAHEDRON</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a606927b36de060292ab110c0ffb8fda6">INVALID</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a4e649a65336a327b2b6a38e937d6e26d">LINE</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a05442bd0a1696fd9414348c072a805df">POLY_LINE</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ac6bd3ea86bc8cff47b41e36049649f96">POLY_VERTEX</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731ae55eaaa4a01ee2d554c70f2e785231bf">PYRAMID</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a70cd9e366650ca00912d1cbe9b61eca2">QUAD</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a97b9c987bb76cf4e7cc9c0a0aa4704ce">TETRAHEDRON</a>, <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731aafad539f241ab0931a414284f3658974">TRIANGLE</a>, and <a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731a74a53207505536ceb0ad64733d2a8a0b">WEDGE</a>.</p>

</div>
</div>
<a id="a10ecb29467c2d7a9cc61c00cc08c6470"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10ecb29467c2d7a9cc61c00cc08c6470">&#9670;&nbsp;</a></span>xmlPrint()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void StructureProperties::xmlPrint </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>o</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>print to an output stream in "pseaudo" XML format. </p>

<p class="reference">References <a class="el" href="classStructureProperties.html#aede0af0788fcc531cca23ff730306b62">index</a>, <a class="el" href="classStructureProperties.html#aadba0e47b44280cd0aa2140542acc0c5">toString()</a>, and <a class="el" href="classStructureProperties.html#a3af910533e21bc25e38bc9b39b9de9be">type</a>.</p>

<p class="reference">Referenced by <a class="el" href="classStructureProperties.html#a6edaa28c6ced40e3e7b2fc3f19be7a5a">~StructureProperties()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aede0af0788fcc531cca23ff730306b62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aede0af0788fcc531cca23ff730306b62">&#9670;&nbsp;</a></span>index</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int StructureProperties::index</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>unique index in the global structure </p>

<p class="reference">Referenced by <a class="el" href="classAtomProperties.html#a31a2cb2ce34e0ba3f3d97327c0b5e52a">AtomProperties::AtomProperties()</a>, <a class="el" href="classCellProperties.html#a96b201fb49315fb1836c84407048274e">CellProperties::CellProperties()</a>, <a class="el" href="classStructureProperties.html#a16b161b8e59a9ed15acd713baf4cde18">getIndex()</a>, <a class="el" href="classStructureProperties.html#a989758e97c3249b5e8f769b353e8aefe">setIndex()</a>, <a class="el" href="classCellProperties.html#a16b6ea7c9f0afbdd7f2c1b5b9fd13575">CellProperties::xmlPrint()</a>, <a class="el" href="classAtomProperties.html#af84ae75eaeaad5729d5875671c6f6120">AtomProperties::xmlPrint()</a>, and <a class="el" href="classStructureProperties.html#a10ecb29467c2d7a9cc61c00cc08c6470">xmlPrint()</a>.</p>

</div>
</div>
<a id="a3af910533e21bc25e38bc9b39b9de9be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3af910533e21bc25e38bc9b39b9de9be">&#9670;&nbsp;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731">GeometricType</a> StructureProperties::type</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The geometric type,. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classStructureProperties.html#a9180a07ccc47844f526e879201d75731" title="Geometric type gives information about which kind of geometric representation is the structure...">StructureProperties::GeometricType</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="classStructureProperties.html#a424fa864b33071bff1e23a9dc8166ebd">getType()</a>, <a class="el" href="classStructureProperties.html#a8c64143e52b2e5239c87343a888a918d">setType()</a>, <a class="el" href="classStructureProperties.html#a0dde5d5125630493e80625b0ebd5d90b">StructureProperties()</a>, and <a class="el" href="classStructureProperties.html#a10ecb29467c2d7a9cc61c00cc08c6470">xmlPrint()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="StructureProperties_8h_source.html">StructureProperties.h</a></li>
<li><a class="el" href="StructureProperties_8cpp.html">StructureProperties.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.