classSimComponent.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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: SimComponent 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="classSimComponent-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">SimComponent Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a4a6b4a8c96c2a4cb2882a26864ddde05"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#a4a6b4a8c96c2a4cb2882a26864ddde05">addComponents</a> (compObjName, compObjName2,...)</td></tr>
  60. <tr class="separator:a4a6b4a8c96c2a4cb2882a26864ddde05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:abbf7a82319ed77f952e85139d64015c0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#abbf7a82319ed77f952e85139d64015c0">getComponent</a> (idx)</td></tr>
  62. <tr class="separator:abbf7a82319ed77f952e85139d64015c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:aef38a65d3f3c6d4f66760315e3a3341c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#aef38a65d3f3c6d4f66760315e3a3341c">getComponentCount</a> ()</td></tr>
  64. <tr class="separator:aef38a65d3f3c6d4f66760315e3a3341c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a56722b6f1c22da04885bc9853148bb71"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#a56722b6f1c22da04885bc9853148bb71">isEnabled</a> ()</td></tr>
  66. <tr class="separator:a56722b6f1c22da04885bc9853148bb71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ad2904f737be702074c10f1617f905a13"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#ad2904f737be702074c10f1617f905a13">removeComponents</a> (compObjName, compObjName2,...)</td></tr>
  68. <tr class="separator:ad2904f737be702074c10f1617f905a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:af8a22cb1cf3aa737bdd42a61cf8fde0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#af8a22cb1cf3aa737bdd42a61cf8fde0a">setEnabled</a> (enabled)</td></tr>
  70. <tr class="separator:af8a22cb1cf3aa737bdd42a61cf8fde0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <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>
  72. <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>
  73. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <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>
  75. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <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>
  77. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  144. Additional Inherited Members</h2></td></tr>
  145. <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>
  146. <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>
  147. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table>
  149. <h2 class="groupheader">Member Function Documentation</h2>
  150. <a class="anchor" id="a4a6b4a8c96c2a4cb2882a26864ddde05"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">bool addComponents </td>
  156. <td>(</td>
  157. <td class="paramtype">compObjName&#160;</td>
  158. <td class="paramname">, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">compObjName2&#160;</td>
  164. <td class="paramname">, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype">&#160;</td>
  170. <td class="paramname"><em>...</em>&#160;</td>
  171. </tr>
  172. <tr>
  173. <td></td>
  174. <td>)</td>
  175. <td></td><td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Adds additional components to current list. </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">Up</td><td>to 62 component names </td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise. </dd></dl>
  187. </div>
  188. </div>
  189. <a class="anchor" id="abbf7a82319ed77f952e85139d64015c0"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">int getComponent </td>
  195. <td>(</td>
  196. <td class="paramtype">idx&#160;</td>
  197. <td class="paramname"></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Get the component corresponding to the given index. </p>
  203. <dl class="params"><dt>Parameters</dt><dd>
  204. <table class="params">
  205. <tr><td class="paramname">idx</td><td>An integer index value corresponding to the desired component. </td></tr>
  206. </table>
  207. </dd>
  208. </dl>
  209. <dl class="section return"><dt>Returns</dt><dd>The id of the component at the given index as an integer </dd></dl>
  210. </div>
  211. </div>
  212. <a class="anchor" id="aef38a65d3f3c6d4f66760315e3a3341c"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">int getComponentCount </td>
  218. <td>(</td>
  219. <td class="paramname"></td><td>)</td>
  220. <td></td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Get the current component count </p>
  225. <dl class="section return"><dt>Returns</dt><dd>The number of components in the list as an integer </dd></dl>
  226. </div>
  227. </div>
  228. <a class="anchor" id="a56722b6f1c22da04885bc9853148bb71"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">bool isEnabled </td>
  234. <td>(</td>
  235. <td class="paramname"></td><td>)</td>
  236. <td></td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Check whether <a class="el" href="classSimComponent.html">SimComponent</a> is currently enabled </p>
  241. <dl class="section return"><dt>Returns</dt><dd>true if enabled and false if not </dd></dl>
  242. </div>
  243. </div>
  244. <a class="anchor" id="ad2904f737be702074c10f1617f905a13"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">bool removeComponents </td>
  250. <td>(</td>
  251. <td class="paramtype">compObjName&#160;</td>
  252. <td class="paramname">, </td>
  253. </tr>
  254. <tr>
  255. <td class="paramkey"></td>
  256. <td></td>
  257. <td class="paramtype">compObjName2&#160;</td>
  258. <td class="paramname">, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">&#160;</td>
  264. <td class="paramname"><em>...</em>&#160;</td>
  265. </tr>
  266. <tr>
  267. <td></td>
  268. <td>)</td>
  269. <td></td><td></td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Removes components by name from current list. </p>
  274. <dl class="params"><dt>Parameters</dt><dd>
  275. <table class="params">
  276. <tr><td class="paramname">objNamex</td><td>Up to 62 component names </td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise. </dd></dl>
  281. </div>
  282. </div>
  283. <a class="anchor" id="af8a22cb1cf3aa737bdd42a61cf8fde0a"></a>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">void setEnabled </td>
  289. <td>(</td>
  290. <td class="paramtype">enabled&#160;</td>
  291. <td class="paramname"></td><td>)</td>
  292. <td></td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Sets or unsets the enabled flag </p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">enabled</td><td>Boolean value </td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  304. </div>
  305. </div>
  306. </div><!-- contents -->
  307. <!-- start footer part -->
  308. <hr class="footer"/><address class="footer"><small>
  309. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  310. <img class="footer" src="doxygen.png" alt="doxygen"/>
  311. </a> 1.8.3.1
  312. </small></address>
  313. </body>
  314. </html>