classSimXMLDocument.html 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  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: SimXMLDocument 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="classSimXMLDocument-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">SimXMLDocument 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:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2f9ffceadf2e149d66ebd9ba4527752">addComment</a> (string comment)</td></tr>
  60. <tr class="separator:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a2845b7ec8d8c307b3ab88ce29c380e93">addData</a> (string text)</td></tr>
  62. <tr class="separator:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a3e6cc0aef931838972cb3adfcc780b44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3e6cc0aef931838972cb3adfcc780b44">addHeader</a> ()</td></tr>
  64. <tr class="separator:a3e6cc0aef931838972cb3adfcc780b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a203646719edb7b16b29d179dcc56af94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a203646719edb7b16b29d179dcc56af94">addNewElement</a> (string name)</td></tr>
  66. <tr class="separator:a203646719edb7b16b29d179dcc56af94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac610bcfeeeec91977cec5bee9d53d3e9">addText</a> (string text)</td></tr>
  68. <tr class="separator:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a863dbcbcdea4b389dd6534ba24e8f2d8"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a863dbcbcdea4b389dd6534ba24e8f2d8">attribute</a> (string attribute)</td></tr>
  70. <tr class="separator:a863dbcbcdea4b389dd6534ba24e8f2d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:abc6417bd7b50620ce73098bd5859540d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#abc6417bd7b50620ce73098bd5859540d">attributeExists</a> (string <a class="el" href="classSimXMLDocument.html#a863dbcbcdea4b389dd6534ba24e8f2d8">attribute</a>)</td></tr>
  72. <tr class="separator:abc6417bd7b50620ce73098bd5859540d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a1e1652b54c372c14d1543d75fc6678e0"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a1e1652b54c372c14d1543d75fc6678e0">attributeF32</a> (string <a class="el" href="classSimXMLDocument.html#a863dbcbcdea4b389dd6534ba24e8f2d8">attribute</a>)</td></tr>
  74. <tr class="separator:a1e1652b54c372c14d1543d75fc6678e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a53903d5839ddfd450fd432faf6b1eb66"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a53903d5839ddfd450fd432faf6b1eb66">attributeS32</a> (string <a class="el" href="classSimXMLDocument.html#a863dbcbcdea4b389dd6534ba24e8f2d8">attribute</a>)</td></tr>
  76. <tr class="separator:a53903d5839ddfd450fd432faf6b1eb66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
  78. <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a926ead67a784f455ddd56590f2928e76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a926ead67a784f455ddd56590f2928e76">clearError</a> ()</td></tr>
  80. <tr class="separator:a926ead67a784f455ddd56590f2928e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a378677624b4c3accbcf9fd7627f1e5e4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a378677624b4c3accbcf9fd7627f1e5e4">elementValue</a> ()</td></tr>
  82. <tr class="separator:a378677624b4c3accbcf9fd7627f1e5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a4348729130b3ed00d0e21818598e214f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a4348729130b3ed00d0e21818598e214f">firstAttribute</a> ()</td></tr>
  84. <tr class="separator:a4348729130b3ed00d0e21818598e214f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:aedccca718ae2810b66af16e9756faf03"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aedccca718ae2810b66af16e9756faf03">getData</a> ()</td></tr>
  86. <tr class="separator:aedccca718ae2810b66af16e9756faf03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a6896066b337ef925aab73257ca8f038c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a6896066b337ef925aab73257ca8f038c">getErrorDesc</a> ()</td></tr>
  88. <tr class="separator:a6896066b337ef925aab73257ca8f038c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a787a8b4145449843adff9e020d9a4ffb"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a787a8b4145449843adff9e020d9a4ffb">getText</a> ()</td></tr>
  90. <tr class="separator:a787a8b4145449843adff9e020d9a4ffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a641c3564d9e7dc02329ff0bd95ce2818"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a641c3564d9e7dc02329ff0bd95ce2818">lastAttribute</a> ()</td></tr>
  92. <tr class="separator:a641c3564d9e7dc02329ff0bd95ce2818"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a3d4b26ed75d3b48c3f877560796c276c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3d4b26ed75d3b48c3f877560796c276c">loadFile</a> (string <a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
  94. <tr class="separator:a3d4b26ed75d3b48c3f877560796c276c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:aa93814d741acc09fe627ed0c18b21850"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa93814d741acc09fe627ed0c18b21850">nextAttribute</a> ()</td></tr>
  96. <tr class="separator:aa93814d741acc09fe627ed0c18b21850"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a1c9b69b751bc6ad01b4f10c075b00f78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a1c9b69b751bc6ad01b4f10c075b00f78">nextSiblingElement</a> (string name)</td></tr>
  98. <tr class="separator:a1c9b69b751bc6ad01b4f10c075b00f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:af43c8e2775211b44390ca8b1092d5acf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#af43c8e2775211b44390ca8b1092d5acf">parse</a> (string txtXML)</td></tr>
  100. <tr class="separator:af43c8e2775211b44390ca8b1092d5acf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ab381b336a3144bf89707335ce3582318"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab381b336a3144bf89707335ce3582318">popElement</a> ()</td></tr>
  102. <tr class="separator:ab381b336a3144bf89707335ce3582318"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aa04c8d00904a0dd7e3cd0c2f4de7459e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa04c8d00904a0dd7e3cd0c2f4de7459e">prevAttribute</a> ()</td></tr>
  104. <tr class="separator:aa04c8d00904a0dd7e3cd0c2f4de7459e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:aa7dbe2fea83125e31b7f9ae9bed5ed9f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa7dbe2fea83125e31b7f9ae9bed5ed9f">pushChildElement</a> (int index)</td></tr>
  106. <tr class="separator:aa7dbe2fea83125e31b7f9ae9bed5ed9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a5a5c558a2b99d7ba92f1b7c521187cef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a5c558a2b99d7ba92f1b7c521187cef">pushFirstChildElement</a> (string name)</td></tr>
  108. <tr class="separator:a5a5c558a2b99d7ba92f1b7c521187cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a31b82c65567a999a3ac712a7e0b66edc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a31b82c65567a999a3ac712a7e0b66edc">pushNewElement</a> (string name)</td></tr>
  110. <tr class="separator:a31b82c65567a999a3ac712a7e0b66edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a96af756e1ccf44301ff2158d8bc89c7d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a96af756e1ccf44301ff2158d8bc89c7d">readComment</a> (S32 index)</td></tr>
  112. <tr class="separator:a96af756e1ccf44301ff2158d8bc89c7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a267fcc4de41221da0969abbe0257cf09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a267fcc4de41221da0969abbe0257cf09">removeText</a> ()</td></tr>
  114. <tr class="separator:a267fcc4de41221da0969abbe0257cf09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
  116. <tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a7019232a607d03cd91a0b6770c4d3628"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a7019232a607d03cd91a0b6770c4d3628">saveFile</a> (string <a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
  118. <tr class="separator:a7019232a607d03cd91a0b6770c4d3628"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a21ea9de7a3577b77f5dbe26e9f50d8">setAttribute</a> (string attributeName, string attributeValue)</td></tr>
  120. <tr class="separator:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae6fe2d098e65cc33f45d7a58f6cd83b7">setObjectAttributes</a> (string attributeValue)</td></tr>
  122. <tr class="separator:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <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>
  125. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <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>
  161. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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>
  163. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <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>
  167. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <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>
  169. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <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>
  171. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <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>
  173. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <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>
  175. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <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>
  177. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <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>
  179. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <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>
  181. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <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>
  183. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <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>
  185. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <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>
  187. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <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>
  189. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <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>
  191. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <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>
  193. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. </table><table class="memberdecls">
  195. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  196. Additional Inherited Members</h2></td></tr>
  197. <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>
  198. <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>
  199. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. </table>
  201. <h2 class="groupheader">Member Function Documentation</h2>
  202. <a class="anchor" id="aa2f9ffceadf2e149d66ebd9ba4527752"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">void addComment </td>
  208. <td>(</td>
  209. <td class="paramtype">string&#160;</td>
  210. <td class="paramname"><em>comment</em></td><td>)</td>
  211. <td></td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Add the given comment as a child of current stack element. </p>
  216. <dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">comment</td><td>The desired comment to add </td></tr>
  219. </table>
  220. </dd>
  221. </dl>
  222. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  223. </div>
  224. </div>
  225. <a class="anchor" id="a2845b7ec8d8c307b3ab88ce29c380e93"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">void addData </td>
  231. <td>(</td>
  232. <td class="paramtype">string&#160;</td>
  233. <td class="paramname"><em>text</em></td><td>)</td>
  234. <td></td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Add the given text as a child of current stack element. </p>
  239. <dl class="params"><dt>Parameters</dt><dd>
  240. <table class="params">
  241. <tr><td class="paramname">The</td><td>desired text to add </td></tr>
  242. </table>
  243. </dd>
  244. </dl>
  245. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  246. </div>
  247. </div>
  248. <a class="anchor" id="a3e6cc0aef931838972cb3adfcc780b44"></a>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">void addHeader </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Add XML header to document. </p>
  261. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  262. </div>
  263. </div>
  264. <a class="anchor" id="a203646719edb7b16b29d179dcc56af94"></a>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">void addNewElement </td>
  270. <td>(</td>
  271. <td class="paramtype">string&#160;</td>
  272. <td class="paramname"><em>name</em></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Create new element as child of current stack element and push new element on to stack. </p>
  278. <dl class="params"><dt>Parameters</dt><dd>
  279. <table class="params">
  280. <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
  281. </table>
  282. </dd>
  283. </dl>
  284. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  285. </div>
  286. </div>
  287. <a class="anchor" id="ac610bcfeeeec91977cec5bee9d53d3e9"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">void addText </td>
  293. <td>(</td>
  294. <td class="paramtype">string&#160;</td>
  295. <td class="paramname"><em>text</em></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Add the given text as a child of current stack element. </p>
  301. <dl class="params"><dt>Parameters</dt><dd>
  302. <table class="params">
  303. <tr><td class="paramname">text</td><td>The desired text to add </td></tr>
  304. </table>
  305. </dd>
  306. </dl>
  307. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  308. </div>
  309. </div>
  310. <a class="anchor" id="a863dbcbcdea4b389dd6534ba24e8f2d8"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">string attribute </td>
  316. <td>(</td>
  317. <td class="paramtype">string&#160;</td>
  318. <td class="paramname"><em>attribute</em></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Get attribute value if it exists. </p>
  324. <dl class="params"><dt>Parameters</dt><dd>
  325. <table class="params">
  326. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute as a string, or an empty string on failure </dd></dl>
  331. </div>
  332. </div>
  333. <a class="anchor" id="abc6417bd7b50620ce73098bd5859540d"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">bool attributeExists </td>
  339. <td>(</td>
  340. <td class="paramtype">string&#160;</td>
  341. <td class="paramname"><em>attribute</em></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Get true if named attribute exists. </p>
  347. <dl class="params"><dt>Parameters</dt><dd>
  348. <table class="params">
  349. <tr><td class="paramname">attribute</td><td>The desired attribute's name </td></tr>
  350. </table>
  351. </dd>
  352. </dl>
  353. <dl class="section return"><dt>Returns</dt><dd>Returns true if attribute exists and false otherwise </dd></dl>
  354. </div>
  355. </div>
  356. <a class="anchor" id="a1e1652b54c372c14d1543d75fc6678e0"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">float attributeF32 </td>
  362. <td>(</td>
  363. <td class="paramtype">string&#160;</td>
  364. <td class="paramname"><em>attribute</em></td><td>)</td>
  365. <td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Get attribute value if it exists. </p>
  370. <dl class="params"><dt>Parameters</dt><dd>
  371. <table class="params">
  372. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit floating-point value from string </dd></dl>
  377. </div>
  378. </div>
  379. <a class="anchor" id="a53903d5839ddfd450fd432faf6b1eb66"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">int attributeS32 </td>
  385. <td>(</td>
  386. <td class="paramtype">string&#160;</td>
  387. <td class="paramname"><em>attribute</em></td><td>)</td>
  388. <td></td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Get attribute value if it exists. </p>
  393. <dl class="params"><dt>Parameters</dt><dd>
  394. <table class="params">
  395. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  396. </table>
  397. </dd>
  398. </dl>
  399. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit integer value from string </dd></dl>
  400. </div>
  401. </div>
  402. <a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">void clear </td>
  408. <td>(</td>
  409. <td class="paramname"></td><td>)</td>
  410. <td></td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <p>Clear contents of XML document. </p>
  415. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  416. </div>
  417. </div>
  418. <a class="anchor" id="a926ead67a784f455ddd56590f2928e76"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">void clearError </td>
  424. <td>(</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Clear error description. </p>
  431. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  432. </div>
  433. </div>
  434. <a class="anchor" id="a378677624b4c3accbcf9fd7627f1e5e4"></a>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">string elementValue </td>
  440. <td>(</td>
  441. <td class="paramname"></td><td>)</td>
  442. <td></td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <p>Get element value if it exists. </p>
  447. <dl class="section return"><dt>Returns</dt><dd>A string with the desired value, or empty if not found. </dd></dl>
  448. </div>
  449. </div>
  450. <a class="anchor" id="a4348729130b3ed00d0e21818598e214f"></a>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname">string firstAttribute </td>
  456. <td>(</td>
  457. <td class="paramname"></td><td>)</td>
  458. <td></td>
  459. </tr>
  460. </table>
  461. </div><div class="memdoc">
  462. <p>Obtain the name of the current element's first attribute. </p>
  463. <dl class="section return"><dt>Returns</dt><dd>A string with the name of the first attribute </dd></dl>
  464. </div>
  465. </div>
  466. <a class="anchor" id="aedccca718ae2810b66af16e9756faf03"></a>
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="memname">
  470. <tr>
  471. <td class="memname">string getData </td>
  472. <td>(</td>
  473. <td class="paramname"></td><td>)</td>
  474. <td></td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <p>Gets the text from the current stack element. </p>
  479. <dl class="section return"><dt>Returns</dt><dd>Returns the desired text or empty string if failed (no text) </dd></dl>
  480. </div>
  481. </div>
  482. <a class="anchor" id="a6896066b337ef925aab73257ca8f038c"></a>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname">string getErrorDesc </td>
  488. <td>(</td>
  489. <td class="paramname"></td><td>)</td>
  490. <td></td>
  491. </tr>
  492. </table>
  493. </div><div class="memdoc">
  494. <p>Get current error description. </p>
  495. <dl class="section return"><dt>Returns</dt><dd>Returns a string with the error description </dd></dl>
  496. </div>
  497. </div>
  498. <a class="anchor" id="a787a8b4145449843adff9e020d9a4ffb"></a>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">string getText </td>
  504. <td>(</td>
  505. <td class="paramname"></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>Gets the text from the current stack element. </p>
  511. <dl class="section return"><dt>Returns</dt><dd>Returns the desired text, or empty string on failure </dd></dl>
  512. </div>
  513. </div>
  514. <a class="anchor" id="a641c3564d9e7dc02329ff0bd95ce2818"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">string lastAttribute </td>
  520. <td>(</td>
  521. <td class="paramname"></td><td>)</td>
  522. <td></td>
  523. </tr>
  524. </table>
  525. </div><div class="memdoc">
  526. <p>Obtain the name of the current element's last attribute. </p>
  527. <dl class="section return"><dt>Returns</dt><dd>A string with the name of the last attribute </dd></dl>
  528. </div>
  529. </div>
  530. <a class="anchor" id="a3d4b26ed75d3b48c3f877560796c276c"></a>
  531. <div class="memitem">
  532. <div class="memproto">
  533. <table class="memname">
  534. <tr>
  535. <td class="memname">int loadFile </td>
  536. <td>(</td>
  537. <td class="paramtype">string&#160;</td>
  538. <td class="paramname"><em>fileName</em></td><td>)</td>
  539. <td></td>
  540. </tr>
  541. </table>
  542. </div><div class="memdoc">
  543. <p>Load file from given filename. </p>
  544. <dl class="params"><dt>Parameters</dt><dd>
  545. <table class="params">
  546. <tr><td class="paramname">fileName</td><td>The name of the desired file </td></tr>
  547. </table>
  548. </dd>
  549. </dl>
  550. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success and 0 otherwise </dd></dl>
  551. </div>
  552. </div>
  553. <a class="anchor" id="aa93814d741acc09fe627ed0c18b21850"></a>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <table class="memname">
  557. <tr>
  558. <td class="memname">string nextAttribute </td>
  559. <td>(</td>
  560. <td class="paramname"></td><td>)</td>
  561. <td></td>
  562. </tr>
  563. </table>
  564. </div><div class="memdoc">
  565. <p>Get the name of the next attribute for the current element after a call to <a class="el" href="classSimXMLDocument.html#a4348729130b3ed00d0e21818598e214f">firstAttribute()</a>. </p>
  566. <dl class="section return"><dt>Returns</dt><dd>A string with the name of the next attribute </dd></dl>
  567. </div>
  568. </div>
  569. <a class="anchor" id="a1c9b69b751bc6ad01b4f10c075b00f78"></a>
  570. <div class="memitem">
  571. <div class="memproto">
  572. <table class="memname">
  573. <tr>
  574. <td class="memname">bool nextSiblingElement </td>
  575. <td>(</td>
  576. <td class="paramtype">string&#160;</td>
  577. <td class="paramname"><em>name</em></td><td>)</td>
  578. <td></td>
  579. </tr>
  580. </table>
  581. </div><div class="memdoc">
  582. <p>Set top element on stack to next element with given name. </p>
  583. <dl class="params"><dt>Parameters</dt><dd>
  584. <table class="params">
  585. <tr><td class="paramname">name</td><td>The name of the element. </td></tr>
  586. </table>
  587. </dd>
  588. </dl>
  589. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
  590. </div>
  591. </div>
  592. <a class="anchor" id="af43c8e2775211b44390ca8b1092d5acf"></a>
  593. <div class="memitem">
  594. <div class="memproto">
  595. <table class="memname">
  596. <tr>
  597. <td class="memname">int parse </td>
  598. <td>(</td>
  599. <td class="paramtype">string&#160;</td>
  600. <td class="paramname"><em>txtXML</em></td><td>)</td>
  601. <td></td>
  602. </tr>
  603. </table>
  604. </div><div class="memdoc">
  605. <p>Create document from XML string. </p>
  606. <dl class="params"><dt>Parameters</dt><dd>
  607. <table class="params">
  608. <tr><td class="paramname">txtXML</td><td>The text of the XML document </td></tr>
  609. </table>
  610. </dd>
  611. </dl>
  612. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success </dd></dl>
  613. </div>
  614. </div>
  615. <a class="anchor" id="ab381b336a3144bf89707335ce3582318"></a>
  616. <div class="memitem">
  617. <div class="memproto">
  618. <table class="memname">
  619. <tr>
  620. <td class="memname">void popElement </td>
  621. <td>(</td>
  622. <td class="paramname"></td><td>)</td>
  623. <td></td>
  624. </tr>
  625. </table>
  626. </div><div class="memdoc">
  627. <p>Pop last element off of stack. </p>
  628. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  629. </div>
  630. </div>
  631. <a class="anchor" id="aa04c8d00904a0dd7e3cd0c2f4de7459e"></a>
  632. <div class="memitem">
  633. <div class="memproto">
  634. <table class="memname">
  635. <tr>
  636. <td class="memname">string prevAttribute </td>
  637. <td>(</td>
  638. <td class="paramname"></td><td>)</td>
  639. <td></td>
  640. </tr>
  641. </table>
  642. </div><div class="memdoc">
  643. <p>Get the name of the previous attribute for the current element after a call to <a class="el" href="classSimXMLDocument.html#a641c3564d9e7dc02329ff0bd95ce2818">lastAttribute()</a>. </p>
  644. <dl class="section return"><dt>Returns</dt><dd>A string with the name of the previous attribute </dd></dl>
  645. </div>
  646. </div>
  647. <a class="anchor" id="aa7dbe2fea83125e31b7f9ae9bed5ed9f"></a>
  648. <div class="memitem">
  649. <div class="memproto">
  650. <table class="memname">
  651. <tr>
  652. <td class="memname">bool pushChildElement </td>
  653. <td>(</td>
  654. <td class="paramtype">int&#160;</td>
  655. <td class="paramname"><em>index</em></td><td>)</td>
  656. <td></td>
  657. </tr>
  658. </table>
  659. </div><div class="memdoc">
  660. <p>Push the child element at the given index onto stack. </p>
  661. <dl class="params"><dt>Parameters</dt><dd>
  662. <table class="params">
  663. <tr><td class="paramname">index</td><td>A nonnegative integer representing the index of the child element </td></tr>
  664. </table>
  665. </dd>
  666. </dl>
  667. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise </dd></dl>
  668. </div>
  669. </div>
  670. <a class="anchor" id="a5a5c558a2b99d7ba92f1b7c521187cef"></a>
  671. <div class="memitem">
  672. <div class="memproto">
  673. <table class="memname">
  674. <tr>
  675. <td class="memname">bool pushFirstChildElement </td>
  676. <td>(</td>
  677. <td class="paramtype">string&#160;</td>
  678. <td class="paramname"><em>name</em></td><td>)</td>
  679. <td></td>
  680. </tr>
  681. </table>
  682. </div><div class="memdoc">
  683. <p>Push first child element with given name onto stack. </p>
  684. <dl class="params"><dt>Parameters</dt><dd>
  685. <table class="params">
  686. <tr><td class="paramname">name</td><td>The name of the child element </td></tr>
  687. </table>
  688. </dd>
  689. </dl>
  690. <dl class="section return"><dt>Returns</dt><dd>returns true on success, false otherwise. </dd></dl>
  691. </div>
  692. </div>
  693. <a class="anchor" id="a31b82c65567a999a3ac712a7e0b66edc"></a>
  694. <div class="memitem">
  695. <div class="memproto">
  696. <table class="memname">
  697. <tr>
  698. <td class="memname">void pushNewElement </td>
  699. <td>(</td>
  700. <td class="paramtype">string&#160;</td>
  701. <td class="paramname"><em>name</em></td><td>)</td>
  702. <td></td>
  703. </tr>
  704. </table>
  705. </div><div class="memdoc">
  706. <p>Create new element as child of current stack element and push new element on to stack. </p>
  707. <dl class="params"><dt>Parameters</dt><dd>
  708. <table class="params">
  709. <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
  710. </table>
  711. </dd>
  712. </dl>
  713. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  714. </div>
  715. </div>
  716. <a class="anchor" id="a96af756e1ccf44301ff2158d8bc89c7d"></a>
  717. <div class="memitem">
  718. <div class="memproto">
  719. <table class="memname">
  720. <tr>
  721. <td class="memname">string readComment </td>
  722. <td>(</td>
  723. <td class="paramtype">S32&#160;</td>
  724. <td class="paramname"><em>index</em></td><td>)</td>
  725. <td></td>
  726. </tr>
  727. </table>
  728. </div><div class="memdoc">
  729. <p>Returns the comment at the specified index. </p>
  730. <dl class="params"><dt>Parameters</dt><dd>
  731. <table class="params">
  732. <tr><td class="paramname">index</td><td>The index of the desired comment as a nonnegative integer value </td></tr>
  733. </table>
  734. </dd>
  735. </dl>
  736. <dl class="section return"><dt>Returns</dt><dd>The comment as a string </dd></dl>
  737. </div>
  738. </div>
  739. <a class="anchor" id="a267fcc4de41221da0969abbe0257cf09"></a>
  740. <div class="memitem">
  741. <div class="memproto">
  742. <table class="memname">
  743. <tr>
  744. <td class="memname">void removeText </td>
  745. <td>(</td>
  746. <td class="paramname"></td><td>)</td>
  747. <td></td>
  748. </tr>
  749. </table>
  750. </div><div class="memdoc">
  751. <p>Remove any text on the current stack element. </p>
  752. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  753. </div>
  754. </div>
  755. <a class="anchor" id="ad20897c5c8bd47f5d4005989bead0e55"></a>
  756. <div class="memitem">
  757. <div class="memproto">
  758. <table class="memname">
  759. <tr>
  760. <td class="memname">void reset </td>
  761. <td>(</td>
  762. <td class="paramname"></td><td>)</td>
  763. <td></td>
  764. </tr>
  765. </table>
  766. </div><div class="memdoc">
  767. <p>Set this to default state at construction. </p>
  768. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  769. </div>
  770. </div>
  771. <a class="anchor" id="a7019232a607d03cd91a0b6770c4d3628"></a>
  772. <div class="memitem">
  773. <div class="memproto">
  774. <table class="memname">
  775. <tr>
  776. <td class="memname">int saveFile </td>
  777. <td>(</td>
  778. <td class="paramtype">string&#160;</td>
  779. <td class="paramname"><em>fileName</em></td><td>)</td>
  780. <td></td>
  781. </tr>
  782. </table>
  783. </div><div class="memdoc">
  784. <p>Save file to given filename. </p>
  785. <dl class="params"><dt>Parameters</dt><dd>
  786. <table class="params">
  787. <tr><td class="paramname">fileName</td><td>A string presenting the filename to save the XML document as </td></tr>
  788. </table>
  789. </dd>
  790. </dl>
  791. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success, and 0 otherwise </dd></dl>
  792. </div>
  793. </div>
  794. <a class="anchor" id="a5a21ea9de7a3577b77f5dbe26e9f50d8"></a>
  795. <div class="memitem">
  796. <div class="memproto">
  797. <table class="memname">
  798. <tr>
  799. <td class="memname">void setAttribute </td>
  800. <td>(</td>
  801. <td class="paramtype">string&#160;</td>
  802. <td class="paramname"><em>attributeName</em>, </td>
  803. </tr>
  804. <tr>
  805. <td class="paramkey"></td>
  806. <td></td>
  807. <td class="paramtype">string&#160;</td>
  808. <td class="paramname"><em>attributeValue</em>&#160;</td>
  809. </tr>
  810. <tr>
  811. <td></td>
  812. <td>)</td>
  813. <td></td><td></td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. <p>Set attribute of top stack element to given value. </p>
  818. <dl class="params"><dt>Parameters</dt><dd>
  819. <table class="params">
  820. <tr><td class="paramname">attributeName</td><td>The name of the attribute of the element you wish to set </td></tr>
  821. <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
  822. </table>
  823. </dd>
  824. </dl>
  825. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  826. </div>
  827. </div>
  828. <a class="anchor" id="ae6fe2d098e65cc33f45d7a58f6cd83b7"></a>
  829. <div class="memitem">
  830. <div class="memproto">
  831. <table class="memname">
  832. <tr>
  833. <td class="memname">void setObjectAttributes </td>
  834. <td>(</td>
  835. <td class="paramtype">string&#160;</td>
  836. <td class="paramname"><em>attributeValue</em></td><td>)</td>
  837. <td></td>
  838. </tr>
  839. </table>
  840. </div><div class="memdoc">
  841. <p>Set attribute of top stack element to given value. </p>
  842. <dl class="params"><dt>Parameters</dt><dd>
  843. <table class="params">
  844. <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
  845. </table>
  846. </dd>
  847. </dl>
  848. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  849. </div>
  850. </div>
  851. </div><!-- contents -->
  852. <!-- start footer part -->
  853. <hr class="footer"/><address class="footer"><small>
  854. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  855. <img class="footer" src="doxygen.png" alt="doxygen"/>
  856. </a> 1.8.3.1
  857. </small></address>
  858. </body>
  859. </html>