classStreamObject.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  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: StreamObject 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="classStreamObject-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">StreamObject 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:a217967620f18fa2b9f1b5ebccc423b48"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a217967620f18fa2b9f1b5ebccc423b48">copyFrom</a> (<a class="el" href="classStreamObject.html">StreamObject</a> other)</td></tr>
  60. <tr class="separator:a217967620f18fa2b9f1b5ebccc423b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a97825791568ee242ca19d25b75030d87"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a97825791568ee242ca19d25b75030d87">getPosition</a> ()</td></tr>
  62. <tr class="separator:a97825791568ee242ca19d25b75030d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ae95bd1ef2a1463049e69f40f28eeb8f1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#ae95bd1ef2a1463049e69f40f28eeb8f1">getStatus</a> ()</td></tr>
  64. <tr class="separator:ae95bd1ef2a1463049e69f40f28eeb8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:adfd7fa6bf96fa7f55717d99973bc2b78"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#adfd7fa6bf96fa7f55717d99973bc2b78">getStreamSize</a> ()</td></tr>
  66. <tr class="separator:adfd7fa6bf96fa7f55717d99973bc2b78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a3884c449ed57d44137e95dd639122220"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a3884c449ed57d44137e95dd639122220">isEOF</a> ()</td></tr>
  68. <tr class="separator:a3884c449ed57d44137e95dd639122220"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ab5c121b699990385bb1c4cf031a59c6f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#ab5c121b699990385bb1c4cf031a59c6f">isEOS</a> ()</td></tr>
  70. <tr class="separator:ab5c121b699990385bb1c4cf031a59c6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a000a4c174c3dce2a5e1d87d8e9be7efa"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a000a4c174c3dce2a5e1d87d8e9be7efa">readLine</a> ()</td></tr>
  72. <tr class="separator:a000a4c174c3dce2a5e1d87d8e9be7efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ad7ba882479e87e667141e6015b17ce9b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#ad7ba882479e87e667141e6015b17ce9b">readLongString</a> (maxLength)</td></tr>
  74. <tr class="separator:ad7ba882479e87e667141e6015b17ce9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a601a36343ca706bd6dcc14945c72967e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a601a36343ca706bd6dcc14945c72967e">readString</a> ()</td></tr>
  76. <tr class="separator:a601a36343ca706bd6dcc14945c72967e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:aca0bb3dc91eebee4c26597cdcdc296c1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#aca0bb3dc91eebee4c26597cdcdc296c1">readSTString</a> ([caseSensitive=false])</td></tr>
  78. <tr class="separator:aca0bb3dc91eebee4c26597cdcdc296c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:af6e77f58796ad0c9214a8bd950e0aa87"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#af6e77f58796ad0c9214a8bd950e0aa87">setPosition</a> (newPosition)</td></tr>
  80. <tr class="separator:af6e77f58796ad0c9214a8bd950e0aa87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a4479e7828e190e17a15d4281ff791e62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a4479e7828e190e17a15d4281ff791e62">writeLine</a> (line)</td></tr>
  82. <tr class="separator:a4479e7828e190e17a15d4281ff791e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a0aad5fd8818bbbdb4430ad6cb66bedca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a0aad5fd8818bbbdb4430ad6cb66bedca">writeLongString</a> (maxLength, string)</td></tr>
  84. <tr class="separator:a0aad5fd8818bbbdb4430ad6cb66bedca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a4e51aefb1cba37cbc97d68018a7a0219"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a4e51aefb1cba37cbc97d68018a7a0219">writeString</a> (string,[maxLength=255])</td></tr>
  86. <tr class="separator:a4e51aefb1cba37cbc97d68018a7a0219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <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>
  89. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  160. Additional Inherited Members</h2></td></tr>
  161. <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>
  162. <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>
  163. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table>
  165. <h2 class="groupheader">Member Function Documentation</h2>
  166. <a class="anchor" id="a217967620f18fa2b9f1b5ebccc423b48"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">bool copyFrom </td>
  172. <td>(</td>
  173. <td class="paramtype"><a class="el" href="classStreamObject.html">StreamObject</a>&#160;</td>
  174. <td class="paramname"><em>other</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Copies stream contents from current position </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">other</td><td>The <a class="el" href="classStreamObject.html">StreamObject</a> from which to copy </td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise. </dd></dl>
  187. </div>
  188. </div>
  189. <a class="anchor" id="a97825791568ee242ca19d25b75030d87"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">int getPosition </td>
  195. <td>(</td>
  196. <td class="paramname"></td><td>)</td>
  197. <td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <dl class="section return"><dt>Returns</dt><dd>Returns the current position in the stream as an integer or zero if failed </dd></dl>
  202. </div>
  203. </div>
  204. <a class="anchor" id="ae95bd1ef2a1463049e69f40f28eeb8f1"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">const char* getStatus </td>
  210. <td>(</td>
  211. <td class="paramname"></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Gets the current status of the <a class="el" href="classStreamObject.html">StreamObject</a> </p>
  217. <dl class="section return"><dt>Returns</dt><dd>The current status as a string (Ok, IOError, EOS, IllegalCall, Closed, UnknownError, Invalid) </dd></dl>
  218. </div>
  219. </div>
  220. <a class="anchor" id="adfd7fa6bf96fa7f55717d99973bc2b78"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">int getStreamSize </td>
  226. <td>(</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <p>Get the size of the stream </p>
  233. <dl class="section return"><dt>Returns</dt><dd>The size of the stream as an integer </dd></dl>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a3884c449ed57d44137e95dd639122220"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">bool isEOF </td>
  242. <td>(</td>
  243. <td class="paramname"></td><td>)</td>
  244. <td></td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Test for end of file stream (identical to <a class="el" href="classStreamObject.html#ab5c121b699990385bb1c4cf031a59c6f">isEOS()</a> </p>
  249. <dl class="section return"><dt>Returns</dt><dd>Returns true if at the end of the stream, false otherwise. </dd></dl>
  250. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classStreamObject.html#ab5c121b699990385bb1c4cf031a59c6f">isEOS</a> </dd></dl>
  251. </div>
  252. </div>
  253. <a class="anchor" id="ab5c121b699990385bb1c4cf031a59c6f"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool isEOS </td>
  259. <td>(</td>
  260. <td class="paramname"></td><td>)</td>
  261. <td></td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Test for end of stream </p>
  266. <dl class="section return"><dt>Returns</dt><dd>Returns true if at the end of the stream, false otherwise. </dd></dl>
  267. </div>
  268. </div>
  269. <a class="anchor" id="a000a4c174c3dce2a5e1d87d8e9be7efa"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">const char* readLine </td>
  275. <td>(</td>
  276. <td class="paramname"></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Read the stream until '\' or EOS </p>
  282. <dl class="section return"><dt>Returns</dt><dd>A string containing the read line or an empty string if failed </dd></dl>
  283. </div>
  284. </div>
  285. <a class="anchor" id="ad7ba882479e87e667141e6015b17ce9b"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">const char* readLongString </td>
  291. <td>(</td>
  292. <td class="paramtype">maxLength&#160;</td>
  293. <td class="paramname"></td><td>)</td>
  294. <td></td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. <p>Reads a string of provided length from the stream buffer. </p>
  299. <dl class="params"><dt>Parameters</dt><dd>
  300. <table class="params">
  301. <tr><td class="paramname">The</td><td>maximum length to read in </td></tr>
  302. </table>
  303. </dd>
  304. </dl>
  305. <dl class="section return"><dt>Returns</dt><dd>The requested string </dd></dl>
  306. </div>
  307. </div>
  308. <a class="anchor" id="a601a36343ca706bd6dcc14945c72967e"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">const char* readString </td>
  314. <td>(</td>
  315. <td class="paramname"></td><td>)</td>
  316. <td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Reads a string from a stream buffer </p>
  321. <dl class="section return"><dt>Returns</dt><dd>The string or an empty string if failed. </dd></dl>
  322. </div>
  323. </div>
  324. <a class="anchor" id="aca0bb3dc91eebee4c26597cdcdc296c1"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">const char* readSTString </td>
  330. <td>(</td>
  331. <td class="paramname"></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Read a String and insert it into a StringTable </p>
  337. <dl class="params"><dt>Parameters</dt><dd>
  338. <table class="params">
  339. <tr><td class="paramname">caseSensitive</td><td>A boolean representing whether the parser should ignore case or not (default false) </td></tr>
  340. </table>
  341. </dd>
  342. </dl>
  343. <dl class="section return"><dt>Returns</dt><dd>Returns the string, or empty string if failed </dd></dl>
  344. </div>
  345. </div>
  346. <a class="anchor" id="af6e77f58796ad0c9214a8bd950e0aa87"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">bool setPosition </td>
  352. <td>(</td>
  353. <td class="paramtype">newPosition&#160;</td>
  354. <td class="paramname"></td><td>)</td>
  355. <td></td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Resets the current stream position </p>
  360. <dl class="params"><dt>Parameters</dt><dd>
  361. <table class="params">
  362. <tr><td class="paramname">The</td><td>desired index </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. <dl class="section return"><dt>Returns</dt><dd>Returns true if succeeded, flase otherwise </dd></dl>
  367. </div>
  368. </div>
  369. <a class="anchor" id="a4479e7828e190e17a15d4281ff791e62"></a>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname">void writeLine </td>
  375. <td>(</td>
  376. <td class="paramtype">line&#160;</td>
  377. <td class="paramname"></td><td>)</td>
  378. <td></td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Writes a line of text to the stream buffer </p>
  383. <dl class="params"><dt>Parameters</dt><dd>
  384. <table class="params">
  385. <tr><td class="paramname">The</td><td>line to write </td></tr>
  386. </table>
  387. </dd>
  388. </dl>
  389. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  390. </div>
  391. </div>
  392. <a class="anchor" id="a0aad5fd8818bbbdb4430ad6cb66bedca"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname">void writeLongString </td>
  398. <td>(</td>
  399. <td class="paramtype">maxLength&#160;</td>
  400. <td class="paramname">, </td>
  401. </tr>
  402. <tr>
  403. <td class="paramkey"></td>
  404. <td></td>
  405. <td class="paramtype">string&#160;</td>
  406. <td class="paramname">&#160;</td>
  407. </tr>
  408. <tr>
  409. <td></td>
  410. <td>)</td>
  411. <td></td><td></td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>Writes a string to buffer or provided length </p>
  416. <dl class="params"><dt>Parameters</dt><dd>
  417. <table class="params">
  418. <tr><td class="paramname">maxLength</td><td>The maximum length to write </td></tr>
  419. <tr><td class="paramname">string</td><td>The string to write </td></tr>
  420. </table>
  421. </dd>
  422. </dl>
  423. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  424. </div>
  425. </div>
  426. <a class="anchor" id="a4e51aefb1cba37cbc97d68018a7a0219"></a>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname">void writeString </td>
  432. <td>(</td>
  433. <td class="paramtype">string&#160;</td>
  434. <td class="paramname"></td><td>)</td>
  435. <td></td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <p>Write a string to the stream buffer </p>
  440. <dl class="params"><dt>Parameters</dt><dd>
  441. <table class="params">
  442. <tr><td class="paramname">string</td><td>The string to write </td></tr>
  443. <tr><td class="paramname">maxLength</td><td>The maximum length to write (default 255). </td></tr>
  444. </table>
  445. </dd>
  446. </dl>
  447. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  448. </div>
  449. </div>
  450. </div><!-- contents -->
  451. <!-- start footer part -->
  452. <hr class="footer"/><address class="footer"><small>
  453. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  454. <img class="footer" src="doxygen.png" alt="doxygen"/>
  455. </a> 1.8.3.1
  456. </small></address>
  457. </body>
  458. </html>