/usr/share/camitk-4.0/apidoc/html/classMultiComponent.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 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 | <!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: MultiComponent 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
 <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-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classMultiComponent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MultiComponent Class Reference<div class="ingroups"><a class="el" href="group__group__cepmodeling.html">CEP Modeling</a> » <a class="el" href="group__group__cepmodeling__libraries.html">Libraries</a> » <a class="el" href="group__group__cepmodeling__libraries__pml.html">PML</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A multi-component stores other components, hence providing a way to have an tree representation of components.
<a href="classMultiComponent.html#details">More...</a></p>
<p><code>#include <<a class="el" href="MultiComponent_8h_source.html">MultiComponent.h</a>></code></p>
<p>Inherits <a class="el" href="classComponent.html">Component</a>.</p>
<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:a42f86da40009bdfc0098d4ce560e2811"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a42f86da40009bdfc0098d4ce560e2811">addSubComponent</a> (<a class="el" href="classComponent.html">Component</a> *)</td></tr>
<tr class="memdesc:a42f86da40009bdfc0098d4ce560e2811"><td class="mdescLeft"> </td><td class="mdescRight">add a component in the list of subcomponents (and set the isExclusive flag accordingly to the state of this <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a>) <a href="#a42f86da40009bdfc0098d4ce560e2811">More...</a><br /></td></tr>
<tr class="separator:a42f86da40009bdfc0098d4ce560e2811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6aa1b41ab8a7b40508f634079b69f95d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a6aa1b41ab8a7b40508f634079b69f95d">deleteAllSubComponents</a> ()</td></tr>
<tr class="memdesc:a6aa1b41ab8a7b40508f634079b69f95d"><td class="mdescLeft"> </td><td class="mdescRight">this method free all the sub-components (i.e. <a href="#a6aa1b41ab8a7b40508f634079b69f95d">More...</a><br /></td></tr>
<tr class="separator:a6aa1b41ab8a7b40508f634079b69f95d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35d4d90d3f18ea6f0b3a551e68b836f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCell.html">Cell</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a35d4d90d3f18ea6f0b3a551e68b836f7">getCell</a> (unsigned int) const</td></tr>
<tr class="memdesc:a35d4d90d3f18ea6f0b3a551e68b836f7"><td class="mdescLeft"> </td><td class="mdescRight">get cell by order number (not cell index) <a href="#a35d4d90d3f18ea6f0b3a551e68b836f7">More...</a><br /></td></tr>
<tr class="separator:a35d4d90d3f18ea6f0b3a551e68b836f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eec57ec0de7bd1be1f1ee748e13c7f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a4eec57ec0de7bd1be1f1ee748e13c7f2">getComponentByName</a> (const std::string)</td></tr>
<tr class="memdesc:a4eec57ec0de7bd1be1f1ee748e13c7f2"><td class="mdescLeft"> </td><td class="mdescRight">conveniant method to get the sub component of the name given in parameter <a href="#a4eec57ec0de7bd1be1f1ee748e13c7f2">More...</a><br /></td></tr>
<tr class="separator:a4eec57ec0de7bd1be1f1ee748e13c7f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ba3cd4227bd54996731e113cca9a6ec"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a8ba3cd4227bd54996731e113cca9a6ec">getNumberOfCells</a> () const</td></tr>
<tr class="memdesc:a8ba3cd4227bd54996731e113cca9a6ec"><td class="mdescLeft"> </td><td class="mdescRight">get the total nr of cell of the component <a href="#a8ba3cd4227bd54996731e113cca9a6ec">More...</a><br /></td></tr>
<tr class="separator:a8ba3cd4227bd54996731e113cca9a6ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af879273038bc84a30e26f0de2cfdfae3"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#af879273038bc84a30e26f0de2cfdfae3">getNumberOfSubComponents</a> () const</td></tr>
<tr class="memdesc:af879273038bc84a30e26f0de2cfdfae3"><td class="mdescLeft"> </td><td class="mdescRight">return the number of subcomponents <a href="#af879273038bc84a30e26f0de2cfdfae3">More...</a><br /></td></tr>
<tr class="separator:af879273038bc84a30e26f0de2cfdfae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79599b29731ec13846ed7f1693798826"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a79599b29731ec13846ed7f1693798826">getSubComponent</a> (const unsigned int) const</td></tr>
<tr class="memdesc:a79599b29731ec13846ed7f1693798826"><td class="mdescLeft"> </td><td class="mdescRight">get a subcomponent by its order number (index in the list of subcomponents) <a href="#a79599b29731ec13846ed7f1693798826">More...</a><br /></td></tr>
<tr class="separator:a79599b29731ec13846ed7f1693798826"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb910929b2af60b83bfb7711b4f9aedd"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#abb910929b2af60b83bfb7711b4f9aedd">isInstanceOf</a> (const char *) const</td></tr>
<tr class="memdesc:abb910929b2af60b83bfb7711b4f9aedd"><td class="mdescLeft"> </td><td class="mdescRight">return true only if the parameter is equal to "MultiComponent" <a href="#abb910929b2af60b83bfb7711b4f9aedd">More...</a><br /></td></tr>
<tr class="separator:abb910929b2af60b83bfb7711b4f9aedd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4079645f3cd4c4463d20a2d1ef93674b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a4079645f3cd4c4463d20a2d1ef93674b">isVisible</a> (const <a class="el" href="classRenderingMode.html#a563f278cfab4af51a7c5d7ffa42f81cb">RenderingMode::Mode</a> mode) const</td></tr>
<tr class="memdesc:a4079645f3cd4c4463d20a2d1ef93674b"><td class="mdescLeft"> </td><td class="mdescRight">return the state of a visibility mode in all the sub component (if at least one sub component is visible for this mode, it will return true; if none are visible it will return false). <a href="#a4079645f3cd4c4463d20a2d1ef93674b">More...</a><br /></td></tr>
<tr class="separator:a4079645f3cd4c4463d20a2d1ef93674b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a93d98fa9daf5d2cf90908735699845"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a4a93d98fa9daf5d2cf90908735699845">MultiComponent</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *)</td></tr>
<tr class="memdesc:a4a93d98fa9daf5d2cf90908735699845"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a4a93d98fa9daf5d2cf90908735699845">More...</a><br /></td></tr>
<tr class="separator:a4a93d98fa9daf5d2cf90908735699845"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99b57841401921c2373065fb4a26d8e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a99b57841401921c2373065fb4a26d8e1">MultiComponent</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *, std::string)</td></tr>
<tr class="memdesc:a99b57841401921c2373065fb4a26d8e1"><td class="mdescLeft"> </td><td class="mdescRight">constructor that allows one to name the structure (provides a name) <a href="#a99b57841401921c2373065fb4a26d8e1">More...</a><br /></td></tr>
<tr class="separator:a99b57841401921c2373065fb4a26d8e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acccdfd8ab194df410dbdce6e2ab80576"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#acccdfd8ab194df410dbdce6e2ab80576">removeSubComponent</a> (<a class="el" href="classComponent.html">Component</a> *c)</td></tr>
<tr class="memdesc:acccdfd8ab194df410dbdce6e2ab80576"><td class="mdescLeft"> </td><td class="mdescRight">Remove a component from the list. <a href="#acccdfd8ab194df410dbdce6e2ab80576">More...</a><br /></td></tr>
<tr class="separator:acccdfd8ab194df410dbdce6e2ab80576"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c9c11c30316554e4a0d5eefdcd5176e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a6c9c11c30316554e4a0d5eefdcd5176e">setPhysicalModel</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *)</td></tr>
<tr class="memdesc:a6c9c11c30316554e4a0d5eefdcd5176e"><td class="mdescLeft"> </td><td class="mdescRight">set the physical model (recursively) <a href="#a6c9c11c30316554e4a0d5eefdcd5176e">More...</a><br /></td></tr>
<tr class="separator:a6c9c11c30316554e4a0d5eefdcd5176e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e92b99c018a3755921fcffeaae00d82"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a5e92b99c018a3755921fcffeaae00d82">setVisible</a> (const <a class="el" href="classRenderingMode.html#a563f278cfab4af51a7c5d7ffa42f81cb">RenderingMode::Mode</a> mode, const bool b)</td></tr>
<tr class="memdesc:a5e92b99c018a3755921fcffeaae00d82"><td class="mdescLeft"> </td><td class="mdescRight">set the state of a visibility mode in all the sub component. <a href="#a5e92b99c018a3755921fcffeaae00d82">More...</a><br /></td></tr>
<tr class="separator:a5e92b99c018a3755921fcffeaae00d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc58eb5091b1f992abc1c7c70c6d11b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#afc58eb5091b1f992abc1c7c70c6d11b5">xmlPrint</a> (std::ostream &) const</td></tr>
<tr class="memdesc:afc58eb5091b1f992abc1c7c70c6d11b5"><td class="mdescLeft"> </td><td class="mdescRight">print to an output stream in "pseaudo" XML format (do nothing if there are no sub components). <a href="#afc58eb5091b1f992abc1c7c70c6d11b5">More...</a><br /></td></tr>
<tr class="separator:afc58eb5091b1f992abc1c7c70c6d11b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1797493a977ba1f01a3ad6097116b0a1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#a1797493a977ba1f01a3ad6097116b0a1">~MultiComponent</a> ()</td></tr>
<tr class="memdesc:a1797493a977ba1f01a3ad6097116b0a1"><td class="mdescLeft"> </td><td class="mdescRight">delete all the subcomponents (call the deleteAllSubComponents method) <a href="#a1797493a977ba1f01a3ad6097116b0a1">More...</a><br /></td></tr>
<tr class="separator:a1797493a977ba1f01a3ad6097116b0a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classComponent')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classComponent.html">Component</a></td></tr>
<tr class="memitem:a49c76437f3ac3abe62ea53e8cd4caa35 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a49c76437f3ac3abe62ea53e8cd4caa35">Component</a> (<a class="el" href="classPhysicalModel.html">PhysicalModel</a> *, std::string n="")</td></tr>
<tr class="memdesc:a49c76437f3ac3abe62ea53e8cd4caa35 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, a component needs to know the PM it is in. <a href="classComponent.html#a49c76437f3ac3abe62ea53e8cd4caa35">More...</a><br /></td></tr>
<tr class="separator:a49c76437f3ac3abe62ea53e8cd4caa35 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad29fac3b3b02575b1f6d0f0d677bf8b inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#aad29fac3b3b02575b1f6d0f0d677bf8b">getName</a> () const</td></tr>
<tr class="memdesc:aad29fac3b3b02575b1f6d0f0d677bf8b inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get the name of the component <a href="classComponent.html#aad29fac3b3b02575b1f6d0f0d677bf8b">More...</a><br /></td></tr>
<tr class="separator:aad29fac3b3b02575b1f6d0f0d677bf8b inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ff2f59a72545b51fb465904a4be4067 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a9ff2f59a72545b51fb465904a4be4067">getPhysicalModel</a> () const</td></tr>
<tr class="memdesc:a9ff2f59a72545b51fb465904a4be4067 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get the physical model <a href="classComponent.html#a9ff2f59a72545b51fb465904a4be4067">More...</a><br /></td></tr>
<tr class="separator:a9ff2f59a72545b51fb465904a4be4067 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d6efb469db526281d2fd3b3303e15a8 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classProperties.html">Properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a1d6efb469db526281d2fd3b3303e15a8">getProperties</a> ()</td></tr>
<tr class="memdesc:a1d6efb469db526281d2fd3b3303e15a8 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get the component structural properties (guarantied to be non NULL) <a href="classComponent.html#a1d6efb469db526281d2fd3b3303e15a8">More...</a><br /></td></tr>
<tr class="separator:a1d6efb469db526281d2fd3b3303e15a8 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03e457e251f98e8dee5ef0232854e903 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a03e457e251f98e8dee5ef0232854e903">isExclusive</a> () const</td></tr>
<tr class="memdesc:a03e457e251f98e8dee5ef0232854e903 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">tell if this component is exclusive or not <a href="classComponent.html#a03e457e251f98e8dee5ef0232854e903">More...</a><br /></td></tr>
<tr class="separator:a03e457e251f98e8dee5ef0232854e903 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e4112bd2933b7d2cdd56530ecdca6ef inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a3e4112bd2933b7d2cdd56530ecdca6ef">setExclusive</a> (const bool)</td></tr>
<tr class="memdesc:a3e4112bd2933b7d2cdd56530ecdca6ef inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">set the exclusive flag <a href="classComponent.html#a3e4112bd2933b7d2cdd56530ecdca6ef">More...</a><br /></td></tr>
<tr class="separator:a3e4112bd2933b7d2cdd56530ecdca6ef inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba12093b619f8f767f1a1a1f9674012e inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#aba12093b619f8f767f1a1a1f9674012e">setName</a> (const std::string)</td></tr>
<tr class="memdesc:aba12093b619f8f767f1a1a1f9674012e inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">set the name of the component <a href="classComponent.html#aba12093b619f8f767f1a1a1f9674012e">More...</a><br /></td></tr>
<tr class="separator:aba12093b619f8f767f1a1a1f9674012e inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8378fa275af98e568a7e91d33d867af inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#ab8378fa275af98e568a7e91d33d867af">~Component</a> ()</td></tr>
<tr class="memdesc:ab8378fa275af98e568a7e91d33d867af inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor needed here as this is an abstract class (pure virtual) <a href="classComponent.html#ab8378fa275af98e568a7e91d33d867af">More...</a><br /></td></tr>
<tr class="separator:ab8378fa275af98e568a7e91d33d867af inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81568beacc3577d3eee4d47a4e7c2a69 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classMultiComponent.html">MultiComponent</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a81568beacc3577d3eee4d47a4e7c2a69">getAllParentMultiComponents</a> ()</td></tr>
<tr class="memdesc:a81568beacc3577d3eee4d47a4e7c2a69 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get the list of all the Multi <a class="el" href="classComponent.html" title="A component is something that composed something and could also be a part of something. ">Component</a> that are using this <a class="el" href="classComponent.html" title="A component is something that composed something and could also be a part of something. ">Component</a> <a href="classComponent.html#a81568beacc3577d3eee4d47a4e7c2a69">More...</a><br /></td></tr>
<tr class="separator:a81568beacc3577d3eee4d47a4e7c2a69 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a757556f31bd64badc4208800ee761e16 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a757556f31bd64badc4208800ee761e16">getNumberOfParentMultiComponents</a> () const</td></tr>
<tr class="memdesc:a757556f31bd64badc4208800ee761e16 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get the number of <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a> that are using this <a class="el" href="classComponent.html" title="A component is something that composed something and could also be a part of something. ">Component</a> (= nr of parent component) <a href="classComponent.html#a757556f31bd64badc4208800ee761e16">More...</a><br /></td></tr>
<tr class="separator:a757556f31bd64badc4208800ee761e16 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a937a0eb2fafd6397917aec4b6c88a34b inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMultiComponent.html">MultiComponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a937a0eb2fafd6397917aec4b6c88a34b">getParentMultiComponent</a> (unsigned int)</td></tr>
<tr class="memdesc:a937a0eb2fafd6397917aec4b6c88a34b inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">get a particular <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a> that is using this <a class="el" href="classComponent.html" title="A component is something that composed something and could also be a part of something. ">Component</a> (a particular parent component) <a href="classComponent.html#a937a0eb2fafd6397917aec4b6c88a34b">More...</a><br /></td></tr>
<tr class="separator:a937a0eb2fafd6397917aec4b6c88a34b inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a929e87689dff88e8186c29fd8992641c inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a929e87689dff88e8186c29fd8992641c">addParentMultiComponent</a> (<a class="el" href="classMultiComponent.html">MultiComponent</a> *)</td></tr>
<tr class="memdesc:a929e87689dff88e8186c29fd8992641c inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">add a particular parent <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a> in the list <a href="classComponent.html#a929e87689dff88e8186c29fd8992641c">More...</a><br /></td></tr>
<tr class="separator:a929e87689dff88e8186c29fd8992641c inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a809c3702d59a1e5ecc72c991d6849883 inherit pub_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a809c3702d59a1e5ecc72c991d6849883">removeParentMultiComponent</a> (<a class="el" href="classMultiComponent.html">MultiComponent</a> *)</td></tr>
<tr class="memdesc:a809c3702d59a1e5ecc72c991d6849883 inherit pub_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">remove a particular parent <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a> <a href="classComponent.html#a809c3702d59a1e5ecc72c991d6849883">More...</a><br /></td></tr>
<tr class="separator:a809c3702d59a1e5ecc72c991d6849883 inherit pub_methods_classComponent"><td class="memSeparator" colspan="2"> </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:ac0278bb56966f631fddde56d6a448b0f"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classComponent.html">Component</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a></td></tr>
<tr class="memdesc:ac0278bb56966f631fddde56d6a448b0f"><td class="mdescLeft"> </td><td class="mdescRight">List of sub component. <a href="#ac0278bb56966f631fddde56d6a448b0f">More...</a><br /></td></tr>
<tr class="separator:ac0278bb56966f631fddde56d6a448b0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classComponent"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classComponent')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classComponent.html">Component</a></td></tr>
<tr class="memitem:a64a48ad79666e51a11c771d7d361253d inherit pro_attribs_classComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classProperties.html">Properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#a64a48ad79666e51a11c771d7d361253d">properties</a></td></tr>
<tr class="separator:a64a48ad79666e51a11c771d7d361253d inherit pro_attribs_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classComponent"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classComponent')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classComponent.html">Component</a></td></tr>
<tr class="memitem:ae71ca92f0a28c65d7aa7e3c4a874da85 inherit pro_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#ae71ca92f0a28c65d7aa7e3c4a874da85">deleteProperties</a> ()</td></tr>
<tr class="memdesc:ae71ca92f0a28c65d7aa7e3c4a874da85 inherit pro_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">delete the "properties" pointer and set it to NULL <a href="classComponent.html#ae71ca92f0a28c65d7aa7e3c4a874da85">More...</a><br /></td></tr>
<tr class="separator:ae71ca92f0a28c65d7aa7e3c4a874da85 inherit pro_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab35e1ee7242ea4829cf240714cd907f2 inherit pro_methods_classComponent"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classComponent.html#ab35e1ee7242ea4829cf240714cd907f2">removeFromParents</a> ()</td></tr>
<tr class="memdesc:ab35e1ee7242ea4829cf240714cd907f2 inherit pro_methods_classComponent"><td class="mdescLeft"> </td><td class="mdescRight">this tell the parent components that this component is removed from memory. <a href="classComponent.html#ab35e1ee7242ea4829cf240714cd907f2">More...</a><br /></td></tr>
<tr class="separator:ab35e1ee7242ea4829cf240714cd907f2 inherit pro_methods_classComponent"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A multi-component stores other components, hence providing a way to have an tree representation of components. </p>
<p>Isn't that tricky?</p>
<dl class="section note"><dt>Note</dt><dd>To delete and free the memory of all the sub components, you have to call the <a class="el" href="classMultiComponent.html#a6aa1b41ab8a7b40508f634079b69f95d" title="this method free all the sub-components (i.e. ">deleteAllSubComponents()</a> method. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a4a93d98fa9daf5d2cf90908735699845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a93d98fa9daf5d2cf90908735699845">◆ </a></span>MultiComponent() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MultiComponent::MultiComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default Constructor. </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
</div>
</div>
<a id="a99b57841401921c2373065fb4a26d8e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b57841401921c2373065fb4a26d8e1">◆ </a></span>MultiComponent() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MultiComponent::MultiComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor that allows one to name the structure (provides a name) </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
</div>
</div>
<a id="a1797493a977ba1f01a3ad6097116b0a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1797493a977ba1f01a3ad6097116b0a1">◆ </a></span>~MultiComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MultiComponent::~MultiComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>delete all the subcomponents (call the deleteAllSubComponents method) </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#a6aa1b41ab8a7b40508f634079b69f95d">deleteAllSubComponents()</a>, <a class="el" href="classComponent.html#ae71ca92f0a28c65d7aa7e3c4a874da85">Component::deleteProperties()</a>, and <a class="el" href="classComponent.html#ab35e1ee7242ea4829cf240714cd907f2">Component::removeFromParents()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a42f86da40009bdfc0098d4ce560e2811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42f86da40009bdfc0098d4ce560e2811">◆ </a></span>addSubComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::addSubComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>c</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>add a component in the list of subcomponents (and set the isExclusive flag accordingly to the state of this <a class="el" href="classMultiComponent.html" title="A multi-component stores other components, hence providing a way to have an tree representation of co...">MultiComponent</a>) </p>
<p class="reference">References <a class="el" href="classComponent.html#a929e87689dff88e8186c29fd8992641c">Component::addParentMultiComponent()</a>, <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>, <a class="el" href="classComponent.html#a03e457e251f98e8dee5ef0232854e903">Component::isExclusive()</a>, and <a class="el" href="classComponent.html#a3e4112bd2933b7d2cdd56530ecdca6ef">Component::setExclusive()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classMultiComponentDC.html#a759d9b2d9cd416c1757b5eeaec677966">MultiComponentDC::addChild()</a>, <a class="el" href="classMultiComponentDCPopup.html#a5b54cf3e8f398d1dbed9d32206223e2e">MultiComponentDCPopup::addNewMultiComponent()</a>, <a class="el" href="classMultiComponentDCPopup.html#ad94f357e710ad60b96b0f56b833bbb98">MultiComponentDCPopup::addNewStructuralComponent()</a>, <a class="el" href="classCreateSC.html#ab035f05c4872e8617367619a47e4966e">CreateSC::apply()</a>, <a class="el" href="classSofaSimulator.html#a4cdb1f379cdb7b6245a50c8fd4b24dd2">SofaSimulator::createPml()</a>, <a class="el" href="classPMLTransform.html#adbd1a55168227d9b3604a03582dd434d">PMLTransform::generateExternalSurface()</a>, <a class="el" href="classPhysicalModel.html#af39a668b88a9fe35bb30b05d2dd0a0bd">PhysicalModel::parseComponents()</a>, <a class="el" href="classPMComponentExtension.html#a948b0f764c92a89c7711dddb2c731a35">PMComponentExtension::save()</a>, <a class="el" href="classPMLComponentExtension.html#ae8c1dc4ef83991b9b9b96adddef39537">PMLComponentExtension::save()</a>, and <a class="el" href="classGenerateModel.html#a42d2f012f557c4caa7ea0a9c5b75da57">GenerateModel::saveMMLFiles()</a>.</p>
</div>
</div>
<a id="a6aa1b41ab8a7b40508f634079b69f95d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aa1b41ab8a7b40508f634079b69f95d">◆ </a></span>deleteAllSubComponents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::deleteAllSubComponents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>this method free all the sub-components (i.e. </p>
<p>delete all the sub component and clear the list). After this methode getNumberOfSubComponents should return 0 </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
<p class="reference">Referenced by <a class="el" href="classMultiComponent.html#a1797493a977ba1f01a3ad6097116b0a1">~MultiComponent()</a>.</p>
</div>
</div>
<a id="a35d4d90d3f18ea6f0b3a551e68b836f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35d4d90d3f18ea6f0b3a551e68b836f7">◆ </a></span>getCell()</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="classCell.html">Cell</a> * MultiComponent::getCell </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>cellOrderNr</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get cell by order number (not cell index) </p>
<p>Implements <a class="el" href="classComponent.html#a2a163c98c31dc32f653826a90d194a73">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
</div>
</div>
<a id="a4eec57ec0de7bd1be1f1ee748e13c7f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eec57ec0de7bd1be1f1ee748e13c7f2">◆ </a></span>getComponentByName()</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="classComponent.html">Component</a> * MultiComponent::getComponentByName </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>n</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>conveniant method to get the sub component of the name given in parameter </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>, and <a class="el" href="classComponent.html#ab0bf67c54f3f019aab737ca0dbefdaa1">Component::isInstanceOf()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPhysicalModel.html#ab849d6a3ea558764b74c334c67afcbd9">PhysicalModel::getComponentByName()</a>, and <a class="el" href="classLoadsManager.html#a7623ffd5a54ac4454ac5a906ddc65632">LoadsManager::updateLoadsDisplay()</a>.</p>
</div>
</div>
<a id="a8ba3cd4227bd54996731e113cca9a6ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ba3cd4227bd54996731e113cca9a6ec">◆ </a></span>getNumberOfCells()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int MultiComponent::getNumberOfCells </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the total nr of cell of the component </p>
<p>Implements <a class="el" href="classComponent.html#a4c947e00d4ef180570cad693a0b557ff">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPhysicalModel.html#a4b8fb9f8b518298c44c985230a99c96e">PhysicalModel::getNumberOfCells()</a>.</p>
</div>
</div>
<a id="af879273038bc84a30e26f0de2cfdfae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af879273038bc84a30e26f0de2cfdfae3">◆ </a></span>getNumberOfSubComponents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int MultiComponent::getNumberOfSubComponents </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 number of subcomponents </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPMLExplorerWidget.html#a5815f70d1ee665abccb663a45d98c5c1">PMLExplorerWidget::buildMultiComponentTreeWidgetItem()</a>, <a class="el" href="classPMLExplorerWidget.html#a32860dc1bcc109362be251acee8d4bb6">PMLExplorerWidget::createMCPropertyList()</a>, <a class="el" href="classPhysicalModel.html#ad87eec82fcd26cf5cf99274272a6800f">PhysicalModel::getNumberOfExclusiveComponents()</a>, <a class="el" href="classPhysicalModel.html#aadd1b7490c09c7fd8b5db351cd2320cc">PhysicalModel::getNumberOfInformativeComponents()</a>, <a class="el" href="classMultiComponentDC.html#a74f8ac66c6391d720d78db44e0cb94c8">MultiComponentDC::MultiComponentDC()</a>, <a class="el" href="classPhysicalModel.html#ad4c0d5affa7af7f897b34fca9e6a0b0b">PhysicalModel::optimizeIndexes()</a>, <a class="el" href="classPMLComponent.html#ab75a16ffec6e7fb6cb532d847b6279d8">PMLComponent::parseMultiComponent()</a>, <a class="el" href="classPMLComponent.html#ae45e217cc8edfc6f6957979a1ce36fe8">PMLComponent::selectMC()</a>, <a class="el" href="classMultiComponent.html#afc58eb5091b1f992abc1c7c70c6d11b5">xmlPrint()</a>, and <a class="el" href="classPhysicalModel.html#ac1fe8c097747e7697143b6ceda34bfae">PhysicalModel::xmlPrint()</a>.</p>
</div>
</div>
<a id="a79599b29731ec13846ed7f1693798826"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79599b29731ec13846ed7f1693798826">◆ </a></span>getSubComponent()</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="classComponent.html">Component</a> * MultiComponent::getSubComponent </td>
<td>(</td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>i</em></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>get a subcomponent by its order number (index in the list of subcomponents) </p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPMLExplorerWidget.html#a5815f70d1ee665abccb663a45d98c5c1">PMLExplorerWidget::buildMultiComponentTreeWidgetItem()</a>, <a class="el" href="classPhysicalModel.html#ae4e6104ed6af9e7fb01ce137896c2bac">PhysicalModel::getExclusiveComponent()</a>, <a class="el" href="classPhysicalModel.html#a4d069c5ccabcf75d3c0313c45c2794f9">PhysicalModel::getInformativeComponent()</a>, <a class="el" href="classMultiComponentDC.html#a74f8ac66c6391d720d78db44e0cb94c8">MultiComponentDC::MultiComponentDC()</a>, <a class="el" href="classPhysicalModel.html#ad4c0d5affa7af7f897b34fca9e6a0b0b">PhysicalModel::optimizeIndexes()</a>, <a class="el" href="classPMLComponent.html#ab75a16ffec6e7fb6cb532d847b6279d8">PMLComponent::parseMultiComponent()</a>, and <a class="el" href="classPMLComponent.html#ae45e217cc8edfc6f6957979a1ce36fe8">PMLComponent::selectMC()</a>.</p>
</div>
</div>
<a id="abb910929b2af60b83bfb7711b4f9aedd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb910929b2af60b83bfb7711b4f9aedd">◆ </a></span>isInstanceOf()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MultiComponent::isInstanceOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>className</em></td><td>)</td>
<td> const</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>return true only if the parameter is equal to "MultiComponent" </p>
<p>Implements <a class="el" href="classComponent.html#ab0bf67c54f3f019aab737ca0dbefdaa1">Component</a>.</p>
</div>
</div>
<a id="a4079645f3cd4c4463d20a2d1ef93674b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4079645f3cd4c4463d20a2d1ef93674b">◆ </a></span>isVisible()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MultiComponent::isVisible </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRenderingMode.html#a563f278cfab4af51a7c5d7ffa42f81cb">RenderingMode::Mode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return the state of a visibility mode in all the sub component (if at least one sub component is visible for this mode, it will return true; if none are visible it will return false). </p>
<p>Implements <a class="el" href="classComponent.html#ae0a1b4ac09c4fae2be1b6e0ca53827a9">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
</div>
</div>
<a id="acccdfd8ab194df410dbdce6e2ab80576"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acccdfd8ab194df410dbdce6e2ab80576">◆ </a></span>removeSubComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::removeSubComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>c</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>Remove a component from the list. </p>
<p>Becareful: this method DOES NOT delete the object and/or free the memory. This method ask the component c to remove this multicomponent from the list of its parent component </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>the ptr to the structure to remove </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>removeAllSubComponent() </dd></dl>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>, and <a class="el" href="classComponent.html#a809c3702d59a1e5ecc72c991d6849883">Component::removeParentMultiComponent()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classMultiComponentDC.html#af3847b1b869a6425cde0de88c67e7508">MultiComponentDC::removeChild()</a>.</p>
</div>
</div>
<a id="a6c9c11c30316554e4a0d5eefdcd5176e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c9c11c30316554e4a0d5eefdcd5176e">◆ </a></span>setPhysicalModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::setPhysicalModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPhysicalModel.html">PhysicalModel</a> * </td>
<td class="paramname"><em>pm</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set the physical model (recursively) </p>
<p>Reimplemented from <a class="el" href="classComponent.html#a741dbc34b41c9d36a1fff8cf7dc0b123">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>, and <a class="el" href="classComponent.html#a741dbc34b41c9d36a1fff8cf7dc0b123">Component::setPhysicalModel()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPhysicalModel.html#ae64ffb5c699270a30492e9bba5ac4f84">PhysicalModel::setExclusiveComponents()</a>, and <a class="el" href="classPhysicalModel.html#af6ce575d66e2c64943e1b24dfe5e02fd">PhysicalModel::setInformativeComponents()</a>.</p>
</div>
</div>
<a id="a5e92b99c018a3755921fcffeaae00d82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e92b99c018a3755921fcffeaae00d82">◆ </a></span>setVisible()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::setVisible </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRenderingMode.html#a563f278cfab4af51a7c5d7ffa42f81cb">RenderingMode::Mode</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set the state of a visibility mode in all the sub component. </p>
<p>Implements <a class="el" href="classComponent.html#a68f4a7d092e3ad402d5054b041bcaed5">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>.</p>
</div>
</div>
<a id="afc58eb5091b1f992abc1c7c70c6d11b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc58eb5091b1f992abc1c7c70c6d11b5">◆ </a></span>xmlPrint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiComponent::xmlPrint </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>print to an output stream in "pseaudo" XML format (do nothing if there are no sub components). </p>
<p>Implements <a class="el" href="classComponent.html#aa166635b9c15d66acb2ea9acdb2c8e7d">Component</a>.</p>
<p class="reference">References <a class="el" href="classMultiComponent.html#ac0278bb56966f631fddde56d6a448b0f">components</a>, <a class="el" href="classProperties.html#aadf1738fdbe4c37d2c25c9d54a21a636">Properties::getField()</a>, <a class="el" href="classComponent.html#aad29fac3b3b02575b1f6d0f0d677bf8b">Component::getName()</a>, <a class="el" href="classMultiComponent.html#af879273038bc84a30e26f0de2cfdfae3">getNumberOfSubComponents()</a>, <a class="el" href="classProperties.html#a3a48d3d852b712e5b83d03235923f3b1">Properties::getString()</a>, <a class="el" href="classProperties.html#a6a333801e00b87b115736fc10a7e81e6">Properties::numberOfFields()</a>, and <a class="el" href="classComponent.html#a64a48ad79666e51a11c771d7d361253d">Component::properties</a>.</p>
<p class="reference">Referenced by <a class="el" href="classPhysicalModel.html#ac1fe8c097747e7697143b6ceda34bfae">PhysicalModel::xmlPrint()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac0278bb56966f631fddde56d6a448b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0278bb56966f631fddde56d6a448b0f">◆ </a></span>components</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector<<a class="el" href="classComponent.html">Component</a> *> MultiComponent::components</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>List of sub component. </p>
<p class="reference">Referenced by <a class="el" href="classMultiComponent.html#a42f86da40009bdfc0098d4ce560e2811">addSubComponent()</a>, <a class="el" href="classMultiComponent.html#a6aa1b41ab8a7b40508f634079b69f95d">deleteAllSubComponents()</a>, <a class="el" href="classMultiComponent.html#a35d4d90d3f18ea6f0b3a551e68b836f7">getCell()</a>, <a class="el" href="classMultiComponent.html#a4eec57ec0de7bd1be1f1ee748e13c7f2">getComponentByName()</a>, <a class="el" href="classMultiComponent.html#a8ba3cd4227bd54996731e113cca9a6ec">getNumberOfCells()</a>, <a class="el" href="classMultiComponent.html#af879273038bc84a30e26f0de2cfdfae3">getNumberOfSubComponents()</a>, <a class="el" href="classMultiComponent.html#a79599b29731ec13846ed7f1693798826">getSubComponent()</a>, <a class="el" href="classMultiComponent.html#a4079645f3cd4c4463d20a2d1ef93674b">isVisible()</a>, <a class="el" href="classMultiComponent.html#a4a93d98fa9daf5d2cf90908735699845">MultiComponent()</a>, <a class="el" href="classMultiComponent.html#acccdfd8ab194df410dbdce6e2ab80576">removeSubComponent()</a>, <a class="el" href="classMultiComponent.html#a6c9c11c30316554e4a0d5eefdcd5176e">setPhysicalModel()</a>, <a class="el" href="classMultiComponent.html#a5e92b99c018a3755921fcffeaae00d82">setVisible()</a>, and <a class="el" href="classMultiComponent.html#afc58eb5091b1f992abc1c7c70c6d11b5">xmlPrint()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="MultiComponent_8h_source.html">MultiComponent.h</a></li>
<li><a class="el" href="MultiComponent_8cpp.html">MultiComponent.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|