classSimSet.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: SimSet Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classSimSet-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">SimSet Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  56. <p>Inherited by <a class="el" href="classModuleDefinition.html">ModuleDefinition</a>, and <a class="el" href="classNameTags.html">NameTags</a>.</p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:a591dfc3d1d5939ac28acf31bfb4cde35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a591dfc3d1d5939ac28acf31bfb4cde35">add</a> (obj1,[obj2]*)</td></tr>
  61. <tr class="separator:a591dfc3d1d5939ac28acf31bfb4cde35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront</a> (object)</td></tr>
  63. <tr class="separator:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a208b9d2546d15546afe1ed644529b8a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a208b9d2546d15546afe1ed644529b8a7">callOnChildren</a> (string method,[string args]*)</td></tr>
  65. <tr class="separator:a208b9d2546d15546afe1ed644529b8a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
  67. <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a54ccf7d816af85ee00644518f0e46f2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a54ccf7d816af85ee00644518f0e46f2b">deleteObjects</a> ()</td></tr>
  69. <tr class="separator:a54ccf7d816af85ee00644518f0e46f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:aaf10d01e6f1dc96c54beff16cd9e4042"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aaf10d01e6f1dc96c54beff16cd9e4042">findObjectByInternalName</a> (string name,[bool searchChildren]?)</td></tr>
  71. <tr class="separator:aaf10d01e6f1dc96c54beff16cd9e4042"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ae452b1c7e00c383f2916c4a530fab737"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ae452b1c7e00c383f2916c4a530fab737">getCount</a> ()</td></tr>
  73. <tr class="separator:ae452b1c7e00c383f2916c4a530fab737"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a8d725cf49ab328abcb1b0cd98eb3bf03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a8d725cf49ab328abcb1b0cd98eb3bf03">getObject</a> (index)</td></tr>
  75. <tr class="separator:a8d725cf49ab328abcb1b0cd98eb3bf03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a5e7fb50e8df7574c1585b7653bf2ef0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a5e7fb50e8df7574c1585b7653bf2ef0e">isMember</a> (object)</td></tr>
  77. <tr class="separator:a5e7fb50e8df7574c1585b7653bf2ef0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a2cecf1a379201b595200c33d479fae80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a2cecf1a379201b595200c33d479fae80">listObjects</a> ()</td></tr>
  79. <tr class="separator:a2cecf1a379201b595200c33d479fae80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack</a> (object)</td></tr>
  81. <tr class="separator:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:aa0240fb07185009d9fe8c0a6a4917bac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aa0240fb07185009d9fe8c0a6a4917bac">remove</a> (obj1,[obj2]*)</td></tr>
  83. <tr class="separator:aa0240fb07185009d9fe8c0a6a4917bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a02cee80758a77628082655b2ec259133"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a02cee80758a77628082655b2ec259133">reorderChild</a> (<a class="el" href="classSimObject.html">SimObject</a> child1, <a class="el" href="classSimObject.html">SimObject</a> child2)</td></tr>
  85. <tr class="separator:a02cee80758a77628082655b2ec259133"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  87. <tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
  88. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
  90. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  92. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  94. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  96. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
  98. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
  100. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
  102. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
  104. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
  106. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
  108. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
  110. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
  112. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
  114. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
  116. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
  118. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
  120. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
  122. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
  124. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
  126. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
  128. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
  130. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
  132. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
  134. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
  136. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa92c3478d4ff5780f0f027598480d772">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>,[selectedOnly]?)</td></tr>
  138. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
  140. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
  142. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
  144. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  146. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  148. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  150. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  152. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  154. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  156. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table><table class="memberdecls">
  158. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  159. Additional Inherited Members</h2></td></tr>
  160. <tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  161. <tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
  162. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. </table>
  164. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  165. <div class="textblock"><p>A container for a sequence of unique SimObjects. Torque2D will automatically remove references to any SimObjects as they are deleted.</p>
  166. <dl class="section user"><dt>Overview</dt><dd></dd></dl>
  167. <p>A <a class="el" href="classSimSet.html">SimSet</a> is an ordered set of references to SimObjects. As the name implies, a <a class="el" href="classSimObject.html">SimObject</a> can appear no more than once within a particular <a class="el" href="classSimSet.html">SimSet</a>. Attempting to add an object to a <a class="el" href="classSimSet.html">SimSet</a> twice will not change the <a class="el" href="classSimSet.html">SimSet</a> nor warn you. However, a <a class="el" href="classSimObject.html">SimObject</a> can be a member of any number of SimSets and acts independently of any <a class="el" href="classSimSet.html">SimSet</a> it is in.</p>
  168. <p>A Simset merely references your SimObjects. The deletion of a <a class="el" href="classSimSet.html">SimSet</a> does not affect the SimObjects it holds, and removing a <a class="el" href="classSimObject.html">SimObject</a> from a <a class="el" href="classSimSet.html">SimSet</a> does not delete the <a class="el" href="classSimObject.html">SimObject</a>.</p>
  169. <p>If a <a class="el" href="classSimSet.html">SimSet</a> contains a <a class="el" href="classSimObject.html">SimObject</a> and that <a class="el" href="classSimObject.html">SimObject</a> is deleted, that <a class="el" href="classSimObject.html">SimObject</a> will also be automatically removed from the <a class="el" href="classSimSet.html">SimSet</a>. This is one of its most powerful features.</p>
  170. <p>Note that only SimObjects can be held in SimSets. Strings, for instance, can not. But, because <a class="el" href="classSimObject.html">SimObject</a> is the base class for almost <em>all</em> script classes, you can add any script class to a <a class="el" href="classSimSet.html">SimSet</a>.</p>
  171. <p>The <a class="el" href="classSimSet.html">SimSet</a>'s member objects are stored initially in the order of insertion (<a class="el" href="classSimSet.html#a591dfc3d1d5939ac28acf31bfb4cde35">add()</a>), and can be removed (<a class="el" href="classSimSet.html#aa0240fb07185009d9fe8c0a6a4917bac">remove()</a>), retrieved (<a class="el" href="classSimSet.html#a8d725cf49ab328abcb1b0cd98eb3bf03">getObject()</a>), and queried (<a class="el" href="classSimSet.html#a5e7fb50e8df7574c1585b7653bf2ef0e">isMember()</a>). The <a class="el" href="classSimSet.html">SimSet</a> can have all its members counted (<a class="el" href="classSimSet.html#ae452b1c7e00c383f2916c4a530fab737">getCount()</a>), printed (<a class="el" href="classSimSet.html#a2cecf1a379201b595200c33d479fae80">listObjects()</a>), and removed (<a class="el" href="classSimSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear()</a>). A member can be reordered via <a class="el" href="classSimSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront()</a> and <a class="el" href="classSimSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack()</a>, or re-ordered relative to another via <a class="el" href="classSimSet.html#a02cee80758a77628082655b2ec259133">reorderChild()</a>.</p>
  172. <dl class="section user"><dt>Examples</dt><dd></dd></dl>
  173. <p><b>Creating and Adding</b></p>
  174. <p>We create the <a class="el" href="classSimSet.html">SimSet</a>, then create objects to put in it, then we add them all in.</p>
  175. <div class="fragment"><div class="line"><span class="keyword">new</span> <a class="code" href="classSimSet.html">SimSet</a>(Fruit);</div>
  176. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getCount());</div>
  177. <div class="line">&gt; 0</div>
  178. <div class="line"></div>
  179. <div class="line"><span class="comment">// Apple, Pear, etc will be SimObjects</span></div>
  180. <div class="line"><span class="keyword">new</span> <a class="code" href="classSimObject.html">SimObject</a>(Apple);</div>
  181. <div class="line"><span class="keyword">new</span> <a class="code" href="classSimObject.html">SimObject</a>(Pear);</div>
  182. <div class="line"><span class="keyword">new</span> <a class="code" href="classSimObject.html">SimObject</a>(Orange);</div>
  183. <div class="line"><span class="keyword">new</span> <a class="code" href="classSimObject.html">SimObject</a>(Fig);</div>
  184. <div class="line"><span class="keyword">new</span> <a class="code" href="classSimObject.html">SimObject</a>(Persimmon);</div>
  185. <div class="line"></div>
  186. <div class="line"><span class="comment">// add our fruit to the SimSet named Fruit</span></div>
  187. <div class="line">Fruit.add(Apple);</div>
  188. <div class="line">Fruit.add(Pear);</div>
  189. <div class="line">Fruit.add(Orange);</div>
  190. <div class="line">Fruit.add(Fig);</div>
  191. <div class="line">Fruit.add(Persimmon);</div>
  192. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getCount());</div>
  193. <div class="line">&gt; 5</div>
  194. </div><!-- fragment --><p><b>Uniqueness</b></p>
  195. <p>Continuing the above example, each member of the <a class="el" href="classSimSet.html">SimSet</a> appears exactly once: the <a class="el" href="classSimSet.html">SimSet</a> is a mathematically proper set.</p>
  196. <div class="fragment"><div class="line"><span class="comment">// Apple is already added.</span></div>
  197. <div class="line">Fruit.add(Apple);</div>
  198. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getCount());</div>
  199. <div class="line">&gt; 5</div>
  200. </div><!-- fragment --><p><b>Re-ordering</b></p>
  201. <p>The members of a <a class="el" href="classSimSet.html">SimSet</a> are well ordered. Let us move a different object to the front.</p>
  202. <div class="fragment"><div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getObject(0).getName());</div>
  203. <div class="line">&gt; Apple</div>
  204. <div class="line"></div>
  205. <div class="line">Fruit.bringToFront(Persimmon);</div>
  206. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getObject(0).getName());</div>
  207. <div class="line">&gt; Persimmon</div>
  208. </div><!-- fragment --><p>Now we move a different member to the back.</p>
  209. <div class="fragment"><div class="line">Fruit.pushToBack(Apple);</div>
  210. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getObject(4).getName());</div>
  211. <div class="line">&gt; Apple</div>
  212. </div><!-- fragment --><p>Finally, we move the Fig member to precede Pear. Note that all of the other members retain their relative order.</p>
  213. <div class="fragment"><div class="line">Fruit.listObjects();</div>
  214. <div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  215. <div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  216. <div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  217. <div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  218. <div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  219. <div class="line"></div>
  220. <div class="line">Fruit.reorderChild(Fig, Pear);</div>
  221. <div class="line">Fruit.listObjects();</div>
  222. <div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  223. <div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  224. <div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  225. <div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  226. <div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code" href="classSimObject.html">SimObject</a> </div>
  227. </div><!-- fragment --><p><b>Removing</b></p>
  228. <div class="fragment"><div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.isMember(Apple));</div>
  229. <div class="line">&gt; 1</div>
  230. <div class="line"></div>
  231. <div class="line">Fruit.remove(Apple);</div>
  232. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.isMember(Apple));</div>
  233. <div class="line">&gt; 0</div>
  234. <div class="line"></div>
  235. <div class="line"><span class="comment">// Apple was not deleted</span></div>
  236. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(<a class="code" href="group__ObjectFunctions.html#ga0a902a1c9a8aced76a92a7787e8c8663">isObject</a>(Apple));</div>
  237. <div class="line">&gt; 1</div>
  238. <div class="line"></div>
  239. <div class="line">Fruit.clear();</div>
  240. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(Fruit.getCount());</div>
  241. <div class="line">&gt; 0</div>
  242. <div class="line"></div>
  243. <div class="line"><span class="comment">// The fruit SimObjects are not deleted. For example...</span></div>
  244. <div class="line"><a class="code" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>(<a class="code" href="group__ObjectFunctions.html#ga0a902a1c9a8aced76a92a7787e8c8663">isObject</a>(Persimmon));</div>
  245. <div class="line">&gt; 1</div>
  246. </div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
  247. <a class="anchor" id="a591dfc3d1d5939ac28acf31bfb4cde35"></a>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">void add </td>
  253. <td>(</td>
  254. <td class="paramtype">obj1&#160;</td>
  255. <td class="paramname">, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">[obj2] *&#160;</td>
  261. <td class="paramname">&#160;</td>
  262. </tr>
  263. <tr>
  264. <td></td>
  265. <td>)</td>
  266. <td></td><td></td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>Appends given <a class="el" href="classSimObject.html">SimObject</a> (or list of SimObjects) to the <a class="el" href="classSimSet.html">SimSet</a>. </p>
  271. <dl class="params"><dt>Parameters</dt><dd>
  272. <table class="params">
  273. <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to add </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="a1ae599ad807bf666a5ef8c965fcb79aa"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">void bringToFront </td>
  286. <td>(</td>
  287. <td class="paramtype">object&#160;</td>
  288. <td class="paramname"></td><td>)</td>
  289. <td></td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Brings <a class="el" href="classSimObject.html">SimObject</a> to front of set. If the <a class="el" href="classSimObject.html">SimObject</a> is not in the set, do nothing. </p>
  294. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  295. </div>
  296. </div>
  297. <a class="anchor" id="a208b9d2546d15546afe1ed644529b8a7"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">void callOnChildren </td>
  303. <td>(</td>
  304. <td class="paramtype">string&#160;</td>
  305. <td class="paramname"><em>method</em>, </td>
  306. </tr>
  307. <tr>
  308. <td class="paramkey"></td>
  309. <td></td>
  310. <td class="paramtype">[string args] *&#160;</td>
  311. <td class="paramname">&#160;</td>
  312. </tr>
  313. <tr>
  314. <td></td>
  315. <td>)</td>
  316. <td></td><td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Call a method on all objects contained in the set. </p>
  321. <dl class="params"><dt>Parameters</dt><dd>
  322. <table class="params">
  323. <tr><td class="paramname">method</td><td>The name of the method to call. </td></tr>
  324. <tr><td class="paramname">args</td><td>The arguments to the method. </td></tr>
  325. </table>
  326. </dd>
  327. </dl>
  328. <dl class="section note"><dt>Note</dt><dd>This method recurses into all SimSets that are children to the set. </dd></dl>
  329. <dl class="section see"><dt>See Also</dt><dd>callOnChildrenNoRecurse" ) </dd></dl>
  330. </div>
  331. </div>
  332. <a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">void clear </td>
  338. <td>(</td>
  339. <td class="paramname"></td><td>)</td>
  340. <td></td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Clears the Simset This does not delete the cleared SimObjects. </p>
  345. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  346. </div>
  347. </div>
  348. <a class="anchor" id="a54ccf7d816af85ee00644518f0e46f2b"></a>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">void deleteObjects </td>
  354. <td>(</td>
  355. <td class="paramname"></td><td>)</td>
  356. <td></td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Deletes all the objects in the <a class="el" href="classSimSet.html">SimSet</a>. </p>
  361. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  362. </div>
  363. </div>
  364. <a class="anchor" id="aaf10d01e6f1dc96c54beff16cd9e4042"></a>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">int findObjectByInternalName </td>
  370. <td>(</td>
  371. <td class="paramtype">string&#160;</td>
  372. <td class="paramname"><em>name</em>, </td>
  373. </tr>
  374. <tr>
  375. <td class="paramkey"></td>
  376. <td></td>
  377. <td class="paramtype">[bool searchChildren] ?&#160;</td>
  378. <td class="paramname">&#160;</td>
  379. </tr>
  380. <tr>
  381. <td></td>
  382. <td>)</td>
  383. <td></td><td></td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <p>Returns the object with given internal name </p>
  388. <dl class="params"><dt>Parameters</dt><dd>
  389. <table class="params">
  390. <tr><td class="paramname">name</td><td>The internal name of the object you wish to find </td></tr>
  391. <tr><td class="paramname">searchChildren</td><td>Set this true if you wish to search all children as well. </td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the object. </dd></dl>
  396. </div>
  397. </div>
  398. <a class="anchor" id="ae452b1c7e00c383f2916c4a530fab737"></a>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">int getCount </td>
  404. <td>(</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td></td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. <dl class="section return"><dt>Returns</dt><dd>Returns the number of objects in the <a class="el" href="classSimSet.html">SimSet</a> </dd></dl>
  411. </div>
  412. </div>
  413. <a class="anchor" id="a8d725cf49ab328abcb1b0cd98eb3bf03"></a>
  414. <div class="memitem">
  415. <div class="memproto">
  416. <table class="memname">
  417. <tr>
  418. <td class="memname">int getObject </td>
  419. <td>(</td>
  420. <td class="paramtype">index&#160;</td>
  421. <td class="paramname"></td><td>)</td>
  422. <td></td>
  423. </tr>
  424. </table>
  425. </div><div class="memdoc">
  426. <p>Returns a member <a class="el" href="classSimObject.html">SimObject</a> of the <a class="el" href="classSimSet.html">SimSet</a> </p>
  427. <dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramname">index</td><td>into this ordered collection (zero-based). </td></tr>
  430. </table>
  431. </dd>
  432. </dl>
  433. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the desired object or -1 on failure </dd></dl>
  434. </div>
  435. </div>
  436. <a class="anchor" id="a5e7fb50e8df7574c1585b7653bf2ef0e"></a>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname">bool isMember </td>
  442. <td>(</td>
  443. <td class="paramtype">object&#160;</td>
  444. <td class="paramname"></td><td>)</td>
  445. <td></td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <dl class="section return"><dt>Returns</dt><dd>Returns true if specified object is a member of the set, and false otherwise </dd></dl>
  450. </div>
  451. </div>
  452. <a class="anchor" id="a2cecf1a379201b595200c33d479fae80"></a>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname">void listObjects </td>
  458. <td>(</td>
  459. <td class="paramname"></td><td>)</td>
  460. <td></td>
  461. </tr>
  462. </table>
  463. </div><div class="memdoc">
  464. <p>Prints the object data within the set </p>
  465. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  466. </div>
  467. </div>
  468. <a class="anchor" id="ab635bca66b0f0d23fa6002b75aa0ee7a"></a>
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="memname">
  472. <tr>
  473. <td class="memname">void pushToBack </td>
  474. <td>(</td>
  475. <td class="paramtype">object&#160;</td>
  476. <td class="paramname"></td><td>)</td>
  477. <td></td>
  478. </tr>
  479. </table>
  480. </div><div class="memdoc">
  481. <p>Sends item to back of set. If the <a class="el" href="classSimObject.html">SimObject</a> is not in the set, do nothing. </p>
  482. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  483. </div>
  484. </div>
  485. <a class="anchor" id="aa0240fb07185009d9fe8c0a6a4917bac"></a>
  486. <div class="memitem">
  487. <div class="memproto">
  488. <table class="memname">
  489. <tr>
  490. <td class="memname">void remove </td>
  491. <td>(</td>
  492. <td class="paramtype">obj1&#160;</td>
  493. <td class="paramname">, </td>
  494. </tr>
  495. <tr>
  496. <td class="paramkey"></td>
  497. <td></td>
  498. <td class="paramtype">[obj2] *&#160;</td>
  499. <td class="paramname">&#160;</td>
  500. </tr>
  501. <tr>
  502. <td></td>
  503. <td>)</td>
  504. <td></td><td></td>
  505. </tr>
  506. </table>
  507. </div><div class="memdoc">
  508. <p>Removes given <a class="el" href="classSimObject.html">SimObject</a> (or list of SimObjects) from the <a class="el" href="classSimSet.html">SimSet</a>. </p>
  509. <dl class="params"><dt>Parameters</dt><dd>
  510. <table class="params">
  511. <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to remove The SimObjects are not deleted. An attempt to remove a <a class="el" href="classSimObject.html">SimObject</a> that is not present in the <a class="el" href="classSimSet.html">SimSet</a> will print a warning and continue. </td></tr>
  512. </table>
  513. </dd>
  514. </dl>
  515. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  516. </div>
  517. </div>
  518. <a class="anchor" id="a02cee80758a77628082655b2ec259133"></a>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="memname">
  522. <tr>
  523. <td class="memname">void reorderChild </td>
  524. <td>(</td>
  525. <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
  526. <td class="paramname"><em>child1</em>, </td>
  527. </tr>
  528. <tr>
  529. <td class="paramkey"></td>
  530. <td></td>
  531. <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
  532. <td class="paramname"><em>child2</em>&#160;</td>
  533. </tr>
  534. <tr>
  535. <td></td>
  536. <td>)</td>
  537. <td></td><td></td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Bring child 1 before child 2 Both SimObjects must already be child objects. If not, the operation silently fails. </p>
  542. <dl class="params"><dt>Parameters</dt><dd>
  543. <table class="params">
  544. <tr><td class="paramname">child1</td><td>The child you wish to set first </td></tr>
  545. <tr><td class="paramname">child2</td><td>The child you wish to set after child1 </td></tr>
  546. </table>
  547. </dd>
  548. </dl>
  549. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  550. </div>
  551. </div>
  552. </div><!-- contents -->
  553. <!-- start footer part -->
  554. <hr class="footer"/><address class="footer"><small>
  555. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  556. <img class="footer" src="doxygen.png" alt="doxygen"/>
  557. </a> 1.8.3.1
  558. </small></address>
  559. </body>
  560. </html>