|
|
@@ -0,0 +1,892 @@
|
|
|
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
+<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
+<head>
|
|
|
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
|
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
|
+<meta name="generator" content="Doxygen 1.8.3.1"/>
|
|
|
+<title>TorqueScript Reference: SimXMLDocument Class Reference</title>
|
|
|
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
|
+<script type="text/javascript" src="jquery.js"></script>
|
|
|
+<script type="text/javascript" src="dynsections.js"></script>
|
|
|
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
|
+<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
|
|
|
+</head>
|
|
|
+<body>
|
|
|
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
|
+<div id="titlearea">
|
|
|
+<table cellspacing="0" cellpadding="0">
|
|
|
+ <tbody>
|
|
|
+ <tr style="height: 56px;">
|
|
|
+ <td style="padding-left: 0.5em;">
|
|
|
+ <div id="projectname">TorqueScript Reference
|
|
|
+ </div>
|
|
|
+ </td>
|
|
|
+ </tr>
|
|
|
+ </tbody>
|
|
|
+</table>
|
|
|
+</div>
|
|
|
+<!-- end header part -->
|
|
|
+<!-- Generated by Doxygen 1.8.3.1 -->
|
|
|
+ <div id="navrow1" class="tabs">
|
|
|
+ <ul class="tablist">
|
|
|
+ <li><a href="index.html"><span>Main Page</span></a></li>
|
|
|
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
|
+ <li><a href="modules.html"><span>Modules</span></a></li>
|
|
|
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
|
+ </ul>
|
|
|
+ </div>
|
|
|
+ <div id="navrow2" class="tabs2">
|
|
|
+ <ul class="tablist">
|
|
|
+ <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
|
+ <li><a href="classes.html"><span>Class Index</span></a></li>
|
|
|
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
|
+ <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
|
+ </ul>
|
|
|
+ </div>
|
|
|
+</div><!-- top -->
|
|
|
+<div class="header">
|
|
|
+ <div class="summary">
|
|
|
+<a href="#pub-methods">Public Member Functions</a> |
|
|
|
+<a href="classSimXMLDocument-members.html">List of all members</a> </div>
|
|
|
+ <div class="headertitle">
|
|
|
+<div class="title">SimXMLDocument Class Reference</div> </div>
|
|
|
+</div><!--header-->
|
|
|
+<div class="contents">
|
|
|
+
|
|
|
+<p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
|
|
|
+<table class="memberdecls">
|
|
|
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
|
+Public Member Functions</h2></td></tr>
|
|
|
+<tr class="memitem:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2f9ffceadf2e149d66ebd9ba4527752">addComment</a> (string comment)</td></tr>
|
|
|
+<tr class="separator:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a2845b7ec8d8c307b3ab88ce29c380e93">addData</a> (string text)</td></tr>
|
|
|
+<tr class="separator:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a3e6cc0aef931838972cb3adfcc780b44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3e6cc0aef931838972cb3adfcc780b44">addHeader</a> ()</td></tr>
|
|
|
+<tr class="separator:a3e6cc0aef931838972cb3adfcc780b44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a203646719edb7b16b29d179dcc56af94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a203646719edb7b16b29d179dcc56af94">addNewElement</a> (string name)</td></tr>
|
|
|
+<tr class="separator:a203646719edb7b16b29d179dcc56af94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac610bcfeeeec91977cec5bee9d53d3e9">addText</a> (string text)</td></tr>
|
|
|
+<tr class="separator:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a863dbcbcdea4b389dd6534ba24e8f2d8"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a863dbcbcdea4b389dd6534ba24e8f2d8">attribute</a> (string attribute)</td></tr>
|
|
|
+<tr class="separator:a863dbcbcdea4b389dd6534ba24e8f2d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:abc6417bd7b50620ce73098bd5859540d"><td class="memItemLeft" align="right" valign="top">bool </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>
|
|
|
+<tr class="separator:abc6417bd7b50620ce73098bd5859540d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a1e1652b54c372c14d1543d75fc6678e0"><td class="memItemLeft" align="right" valign="top">float </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>
|
|
|
+<tr class="separator:a1e1652b54c372c14d1543d75fc6678e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a53903d5839ddfd450fd432faf6b1eb66"><td class="memItemLeft" align="right" valign="top">int </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>
|
|
|
+<tr class="separator:a53903d5839ddfd450fd432faf6b1eb66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
|
|
|
+<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a926ead67a784f455ddd56590f2928e76"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a926ead67a784f455ddd56590f2928e76">clearError</a> ()</td></tr>
|
|
|
+<tr class="separator:a926ead67a784f455ddd56590f2928e76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a378677624b4c3accbcf9fd7627f1e5e4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a378677624b4c3accbcf9fd7627f1e5e4">elementValue</a> ()</td></tr>
|
|
|
+<tr class="separator:a378677624b4c3accbcf9fd7627f1e5e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a4348729130b3ed00d0e21818598e214f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a4348729130b3ed00d0e21818598e214f">firstAttribute</a> ()</td></tr>
|
|
|
+<tr class="separator:a4348729130b3ed00d0e21818598e214f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aedccca718ae2810b66af16e9756faf03"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aedccca718ae2810b66af16e9756faf03">getData</a> ()</td></tr>
|
|
|
+<tr class="separator:aedccca718ae2810b66af16e9756faf03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a6896066b337ef925aab73257ca8f038c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a6896066b337ef925aab73257ca8f038c">getErrorDesc</a> ()</td></tr>
|
|
|
+<tr class="separator:a6896066b337ef925aab73257ca8f038c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a787a8b4145449843adff9e020d9a4ffb"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a787a8b4145449843adff9e020d9a4ffb">getText</a> ()</td></tr>
|
|
|
+<tr class="separator:a787a8b4145449843adff9e020d9a4ffb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a641c3564d9e7dc02329ff0bd95ce2818"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a641c3564d9e7dc02329ff0bd95ce2818">lastAttribute</a> ()</td></tr>
|
|
|
+<tr class="separator:a641c3564d9e7dc02329ff0bd95ce2818"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a3d4b26ed75d3b48c3f877560796c276c"><td class="memItemLeft" align="right" valign="top">int </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>
|
|
|
+<tr class="separator:a3d4b26ed75d3b48c3f877560796c276c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa93814d741acc09fe627ed0c18b21850"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa93814d741acc09fe627ed0c18b21850">nextAttribute</a> ()</td></tr>
|
|
|
+<tr class="separator:aa93814d741acc09fe627ed0c18b21850"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a1c9b69b751bc6ad01b4f10c075b00f78"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a1c9b69b751bc6ad01b4f10c075b00f78">nextSiblingElement</a> (string name)</td></tr>
|
|
|
+<tr class="separator:a1c9b69b751bc6ad01b4f10c075b00f78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:af43c8e2775211b44390ca8b1092d5acf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#af43c8e2775211b44390ca8b1092d5acf">parse</a> (string txtXML)</td></tr>
|
|
|
+<tr class="separator:af43c8e2775211b44390ca8b1092d5acf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ab381b336a3144bf89707335ce3582318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab381b336a3144bf89707335ce3582318">popElement</a> ()</td></tr>
|
|
|
+<tr class="separator:ab381b336a3144bf89707335ce3582318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa04c8d00904a0dd7e3cd0c2f4de7459e"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa04c8d00904a0dd7e3cd0c2f4de7459e">prevAttribute</a> ()</td></tr>
|
|
|
+<tr class="separator:aa04c8d00904a0dd7e3cd0c2f4de7459e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa7dbe2fea83125e31b7f9ae9bed5ed9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa7dbe2fea83125e31b7f9ae9bed5ed9f">pushChildElement</a> (int index)</td></tr>
|
|
|
+<tr class="separator:aa7dbe2fea83125e31b7f9ae9bed5ed9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a5a5c558a2b99d7ba92f1b7c521187cef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a5c558a2b99d7ba92f1b7c521187cef">pushFirstChildElement</a> (string name)</td></tr>
|
|
|
+<tr class="separator:a5a5c558a2b99d7ba92f1b7c521187cef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a31b82c65567a999a3ac712a7e0b66edc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a31b82c65567a999a3ac712a7e0b66edc">pushNewElement</a> (string name)</td></tr>
|
|
|
+<tr class="separator:a31b82c65567a999a3ac712a7e0b66edc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a96af756e1ccf44301ff2158d8bc89c7d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a96af756e1ccf44301ff2158d8bc89c7d">readComment</a> (S32 index)</td></tr>
|
|
|
+<tr class="separator:a96af756e1ccf44301ff2158d8bc89c7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a267fcc4de41221da0969abbe0257cf09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a267fcc4de41221da0969abbe0257cf09">removeText</a> ()</td></tr>
|
|
|
+<tr class="separator:a267fcc4de41221da0969abbe0257cf09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
|
|
|
+<tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a7019232a607d03cd91a0b6770c4d3628"><td class="memItemLeft" align="right" valign="top">int </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>
|
|
|
+<tr class="separator:a7019232a607d03cd91a0b6770c4d3628"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a21ea9de7a3577b77f5dbe26e9f50d8">setAttribute</a> (string attributeName, string attributeValue)</td></tr>
|
|
|
+<tr class="separator:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae6fe2d098e65cc33f45d7a58f6cd83b7">setObjectAttributes</a> (string attributeValue)</td></tr>
|
|
|
+<tr class="separator:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
|
|
|
+<tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
|
|
|
+<tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
|
|
|
+<tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
|
|
|
+<tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
|
|
|
+<tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
|
|
|
+<tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
|
|
|
+<tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
|
|
|
+<tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
|
|
|
+<tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
|
|
|
+<tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
|
|
|
+<tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
|
|
|
+<tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
|
|
|
+<tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
|
|
|
+<tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
|
|
|
+<tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
|
|
|
+<tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
|
|
|
+<tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
|
|
|
+<tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
|
|
|
+<tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
|
|
|
+<tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
|
|
|
+<tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
|
|
|
+<tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
|
|
|
+<tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
|
|
|
+<tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
|
|
|
+<tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
|
|
|
+<tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </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>
|
|
|
+<tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
|
|
|
+<tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
|
|
|
+<tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
|
|
|
+<tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
|
|
|
+<tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
|
|
|
+<tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
|
|
|
+<tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
|
|
|
+<tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
|
|
|
+<tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
|
|
|
+<tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+</table><table class="memberdecls">
|
|
|
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
|
+Additional Inherited Members</h2></td></tr>
|
|
|
+<tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
|
|
|
+<tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
|
|
|
+<tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+</table>
|
|
|
+<h2 class="groupheader">Member Function Documentation</h2>
|
|
|
+<a class="anchor" id="aa2f9ffceadf2e149d66ebd9ba4527752"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void addComment </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>comment</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Add the given comment as a child of current stack element. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">comment</td><td>The desired comment to add </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a2845b7ec8d8c307b3ab88ce29c380e93"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void addData </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>text</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Add the given text as a child of current stack element. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">The</td><td>desired text to add </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a3e6cc0aef931838972cb3adfcc780b44"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void addHeader </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Add XML header to document. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a203646719edb7b16b29d179dcc56af94"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void addNewElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>name</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Create new element as child of current stack element and push new element on to stack. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ac610bcfeeeec91977cec5bee9d53d3e9"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void addText </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>text</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Add the given text as a child of current stack element. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">text</td><td>The desired text to add </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a863dbcbcdea4b389dd6534ba24e8f2d8"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string attribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attribute</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get attribute value if it exists. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<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>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="abc6417bd7b50620ce73098bd5859540d"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">bool attributeExists </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attribute</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get true if named attribute exists. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attribute</td><td>The desired attribute's name </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns true if attribute exists and false otherwise </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a1e1652b54c372c14d1543d75fc6678e0"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">float attributeF32 </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attribute</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get attribute value if it exists. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<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>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a53903d5839ddfd450fd432faf6b1eb66"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int attributeS32 </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attribute</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get attribute value if it exists. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit integer value from string </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void clear </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Clear contents of XML document. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a926ead67a784f455ddd56590f2928e76"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void clearError </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Clear error description. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a378677624b4c3accbcf9fd7627f1e5e4"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string elementValue </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get element value if it exists. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A string with the desired value, or empty if not found. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a4348729130b3ed00d0e21818598e214f"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string firstAttribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Obtain the name of the current element's first attribute. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A string with the name of the first attribute </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="aedccca718ae2810b66af16e9756faf03"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string getData </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the text from the current stack element. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns the desired text or empty string if failed (no text) </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a6896066b337ef925aab73257ca8f038c"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string getErrorDesc </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Get current error description. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns a string with the error description </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a787a8b4145449843adff9e020d9a4ffb"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string getText </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the text from the current stack element. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns the desired text, or empty string on failure </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a641c3564d9e7dc02329ff0bd95ce2818"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string lastAttribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Obtain the name of the current element's last attribute. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A string with the name of the last attribute </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a3d4b26ed75d3b48c3f877560796c276c"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int loadFile </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>fileName</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Load file from given filename. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">fileName</td><td>The name of the desired file </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns 1 on success and 0 otherwise </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="aa93814d741acc09fe627ed0c18b21850"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string nextAttribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<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>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A string with the name of the next attribute </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a1c9b69b751bc6ad01b4f10c075b00f78"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">bool nextSiblingElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>name</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Set top element on stack to next element with given name. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">name</td><td>The name of the element. </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="af43c8e2775211b44390ca8b1092d5acf"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int parse </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>txtXML</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Create document from XML string. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">txtXML</td><td>The text of the XML document </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns 1 on success </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ab381b336a3144bf89707335ce3582318"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void popElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Pop last element off of stack. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="aa04c8d00904a0dd7e3cd0c2f4de7459e"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string prevAttribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<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>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A string with the name of the previous attribute </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="aa7dbe2fea83125e31b7f9ae9bed5ed9f"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">bool pushChildElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">int </td>
|
|
|
+ <td class="paramname"><em>index</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Push the child element at the given index onto stack. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">index</td><td>A nonnegative integer representing the index of the child element </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a5a5c558a2b99d7ba92f1b7c521187cef"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">bool pushFirstChildElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>name</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Push first child element with given name onto stack. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">name</td><td>The name of the child element </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>returns true on success, false otherwise. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a31b82c65567a999a3ac712a7e0b66edc"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void pushNewElement </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>name</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Create new element as child of current stack element and push new element on to stack. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a96af756e1ccf44301ff2158d8bc89c7d"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">string readComment </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">S32 </td>
|
|
|
+ <td class="paramname"><em>index</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Returns the comment at the specified index. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">index</td><td>The index of the desired comment as a nonnegative integer value </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The comment as a string </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a267fcc4de41221da0969abbe0257cf09"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void removeText </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Remove any text on the current stack element. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ad20897c5c8bd47f5d4005989bead0e55"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void reset </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Set this to default state at construction. </p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a7019232a607d03cd91a0b6770c4d3628"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int saveFile </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>fileName</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Save file to given filename. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">fileName</td><td>A string presenting the filename to save the XML document as </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>Returns 1 on success, and 0 otherwise </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a5a21ea9de7a3577b77f5dbe26e9f50d8"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void setAttribute </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attributeName</em>, </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td class="paramkey"></td>
|
|
|
+ <td></td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attributeValue</em> </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td></td>
|
|
|
+ <td>)</td>
|
|
|
+ <td></td><td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Set attribute of top stack element to given value. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attributeName</td><td>The name of the attribute of the element you wish to set </td></tr>
|
|
|
+ <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ae6fe2d098e65cc33f45d7a58f6cd83b7"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void setObjectAttributes </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">string </td>
|
|
|
+ <td class="paramname"><em>attributeValue</em></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Set attribute of top stack element to given value. </p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</div><!-- contents -->
|
|
|
+<!-- start footer part -->
|
|
|
+<hr class="footer"/><address class="footer"><small>
|
|
|
+Generated by  <a href="http://www.doxygen.org/index.html">
|
|
|
+<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
|
+</a> 1.8.3.1
|
|
|
+</small></address>
|
|
|
+</body>
|
|
|
+</html>
|