classZipObject.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  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: ZipObject 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="#pub-static-attribs">Static Public Attributes</a> &#124;
  51. <a href="classZipObject-members.html">List of all members</a> </div>
  52. <div class="headertitle">
  53. <div class="title">ZipObject Class Reference</div> </div>
  54. </div><!--header-->
  55. <div class="contents">
  56. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:a199d346e620bdca3c47bd00e51fbc735"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a199d346e620bdca3c47bd00e51fbc735">addFile</a> (filename, pathInZip,[replace=true]?)</td></tr>
  61. <tr class="separator:a199d346e620bdca3c47bd00e51fbc735"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a3a5c2200839483da2c31b171e993a0c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a3a5c2200839483da2c31b171e993a0c0">closeArchive</a> ()</td></tr>
  63. <tr class="separator:a3a5c2200839483da2c31b171e993a0c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ad2232b510598c27d3c93f7e06a145e02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#ad2232b510598c27d3c93f7e06a145e02">closeFile</a> (stream)</td></tr>
  65. <tr class="separator:ad2232b510598c27d3c93f7e06a145e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a7f969b8f8daeab091b2582e870e14108"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a7f969b8f8daeab091b2582e870e14108">deleteFile</a> (pathInZip)</td></tr>
  67. <tr class="separator:a7f969b8f8daeab091b2582e870e14108"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a8bf4c5f13884294a3912cabd6c46cc1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a8bf4c5f13884294a3912cabd6c46cc1f">extractFile</a> (pathInZip, filename)</td></tr>
  69. <tr class="separator:a8bf4c5f13884294a3912cabd6c46cc1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a414d845699d61128f61df94e3c0095e4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a414d845699d61128f61df94e3c0095e4">getFileEntry</a> (index)</td></tr>
  71. <tr class="separator:a414d845699d61128f61df94e3c0095e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a1d778efb0df9c88b0e5f3e265f6f64b9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a1d778efb0df9c88b0e5f3e265f6f64b9">getFileEntryCount</a> ()</td></tr>
  73. <tr class="separator:a1d778efb0df9c88b0e5f3e265f6f64b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ad4e38df211836d0474e9fb59f5cd0621"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#ad4e38df211836d0474e9fb59f5cd0621">openArchive</a> (filename,[accessMode=Read]?)</td></tr>
  75. <tr class="separator:ad4e38df211836d0474e9fb59f5cd0621"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ac07473c2eadf8546afa55592f6993e44"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#ac07473c2eadf8546afa55592f6993e44">openFileForRead</a> (filename)</td></tr>
  77. <tr class="separator:ac07473c2eadf8546afa55592f6993e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a19929a27566f853b38b9d184156ee350"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a19929a27566f853b38b9d184156ee350">openFileForWrite</a> (filename)</td></tr>
  79. <tr class="separator:a19929a27566f853b38b9d184156ee350"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <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>
  82. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <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>
  84. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <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>
  86. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <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>
  150. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. </table><table class="memberdecls">
  152. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  153. Static Public Attributes</h2></td></tr>
  154. <tr class="memitem:a6521cd7227b2239fa4c2168ce1fa8d10"><td class="memItemLeft" >struct {</td></tr>
  155. <tr class="memitem:ac6c3dfb4c3a68f849f32cbfb21da4e77"><td class="memItemLeft" >&#160;&#160;&#160;Zip::ZipArchive::AccessMode&#160;&#160;&#160;<a class="el" href="classZipObject.html#ac6c3dfb4c3a68f849f32cbfb21da4e77">mode</a></td></tr>
  156. <tr class="separator:ac6c3dfb4c3a68f849f32cbfb21da4e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:ab9eced2c5fab5729cc642106eaf65d9a"><td class="memItemLeft" >&#160;&#160;&#160;const char *&#160;&#160;&#160;<a class="el" href="classZipObject.html#ab9eced2c5fab5729cc642106eaf65d9a">strMode</a></td></tr>
  158. <tr class="separator:ab9eced2c5fab5729cc642106eaf65d9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a6521cd7227b2239fa4c2168ce1fa8d10"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a6521cd7227b2239fa4c2168ce1fa8d10">gModeMap</a> []</td></tr>
  160. <tr class="separator:a6521cd7227b2239fa4c2168ce1fa8d10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table><table class="memberdecls">
  162. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  163. Additional Inherited Members</h2></td></tr>
  164. <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>
  165. <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>
  166. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <h2 class="groupheader">Member Function Documentation</h2>
  169. <a class="anchor" id="a199d346e620bdca3c47bd00e51fbc735"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">bool addFile </td>
  175. <td>(</td>
  176. <td class="paramtype">filename&#160;</td>
  177. <td class="paramname">, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">pathInZip&#160;</td>
  183. <td class="paramname">, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">[replace = true] ?&#160;</td>
  189. <td class="paramname">&#160;</td>
  190. </tr>
  191. <tr>
  192. <td></td>
  193. <td>)</td>
  194. <td></td><td></td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>Add a file to the zip </p>
  199. <dl class="params"><dt>Parameters</dt><dd>
  200. <table class="params">
  201. <tr><td class="paramname">filename</td><td>The name of the file </td></tr>
  202. <tr><td class="paramname">pathInZip</td><td>The internal (to the zip) path to the file </td></tr>
  203. <tr><td class="paramname">replace</td><td>Set whether to replace the file if one already exists with the name in the path (default true) </td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise </dd></dl>
  208. </div>
  209. </div>
  210. <a class="anchor" id="a3a5c2200839483da2c31b171e993a0c0"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">void closeArchive </td>
  216. <td>(</td>
  217. <td class="paramname"></td><td>)</td>
  218. <td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Close the zip file </p>
  223. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  224. </div>
  225. </div>
  226. <a class="anchor" id="ad2232b510598c27d3c93f7e06a145e02"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">void closeFile </td>
  232. <td>(</td>
  233. <td class="paramtype">stream&#160;</td>
  234. <td class="paramname"></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Close a file within the zip </p>
  240. <dl class="params"><dt>Parameters</dt><dd>
  241. <table class="params">
  242. <tr><td class="paramname">stream</td><td>The file stream ID </td></tr>
  243. </table>
  244. </dd>
  245. </dl>
  246. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  247. </div>
  248. </div>
  249. <a class="anchor" id="a7f969b8f8daeab091b2582e870e14108"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">bool deleteFile </td>
  255. <td>(</td>
  256. <td class="paramtype">pathInZip&#160;</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Delete a file from the zip </p>
  263. <dl class="params"><dt>Parameters</dt><dd>
  264. <table class="params">
  265. <tr><td class="paramname">pathInZip</td><td>The full internal path of the file </td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise. </dd></dl>
  270. </div>
  271. </div>
  272. <a class="anchor" id="a8bf4c5f13884294a3912cabd6c46cc1f"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname">bool extractFile </td>
  278. <td>(</td>
  279. <td class="paramtype">pathInZip&#160;</td>
  280. <td class="paramname">, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype">filename&#160;</td>
  286. <td class="paramname">&#160;</td>
  287. </tr>
  288. <tr>
  289. <td></td>
  290. <td>)</td>
  291. <td></td><td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Extract a file from the zip </p>
  296. <dl class="params"><dt>Parameters</dt><dd>
  297. <table class="params">
  298. <tr><td class="paramname">pathInZip</td><td>The internal path of the desired file </td></tr>
  299. <tr><td class="paramname">filename</td><td>The file's name </td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise </dd></dl>
  304. </div>
  305. </div>
  306. <a class="anchor" id="a414d845699d61128f61df94e3c0095e4"></a>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">string getFileEntry </td>
  312. <td>(</td>
  313. <td class="paramtype">index&#160;</td>
  314. <td class="paramname"></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Get file entry. </p>
  320. <dl class="params"><dt>Parameters</dt><dd>
  321. <table class="params">
  322. <tr><td class="paramname">index</td><td>Index to file entry </td></tr>
  323. </table>
  324. </dd>
  325. </dl>
  326. <dl class="section return"><dt>Returns</dt><dd>Returns tab separated string containing filename, uncompressed size, compressed size, compression method and CRC32 </dd></dl>
  327. </div>
  328. </div>
  329. <a class="anchor" id="a1d778efb0df9c88b0e5f3e265f6f64b9"></a>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">int getFileEntryCount </td>
  335. <td>(</td>
  336. <td class="paramname"></td><td>)</td>
  337. <td></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>Get number of files in the zip </p>
  342. <dl class="section return"><dt>Returns</dt><dd>Returns the number of files found in zip </dd></dl>
  343. </div>
  344. </div>
  345. <a class="anchor" id="ad4e38df211836d0474e9fb59f5cd0621"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">bool openArchive </td>
  351. <td>(</td>
  352. <td class="paramtype">filename&#160;</td>
  353. <td class="paramname">, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">[accessMode = Read] ?&#160;</td>
  359. <td class="paramname">&#160;</td>
  360. </tr>
  361. <tr>
  362. <td></td>
  363. <td>)</td>
  364. <td></td><td></td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Open a zip file </p>
  369. <dl class="params"><dt>Parameters</dt><dd>
  370. <table class="params">
  371. <tr><td class="paramname">filename</td><td>The file's name </td></tr>
  372. <tr><td class="paramname">accessMode</td><td>The mode in which to open the file (default Read) </td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
  377. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classZipObject.html#a3a5c2200839483da2c31b171e993a0c0">closeArchive</a>, <a class="el" href="classZipObject.html#ac07473c2eadf8546afa55592f6993e44">openFileForRead</a>, <a class="el" href="classZipObject.html#a19929a27566f853b38b9d184156ee350">openFileForWrite</a>, <a class="el" href="classZipObject.html#ad2232b510598c27d3c93f7e06a145e02">closeFile</a> </dd></dl>
  378. </div>
  379. </div>
  380. <a class="anchor" id="ac07473c2eadf8546afa55592f6993e44"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">int openFileForRead </td>
  386. <td>(</td>
  387. <td class="paramtype">filename&#160;</td>
  388. <td class="paramname"></td><td>)</td>
  389. <td></td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <p>Open a file within the zip for reading </p>
  394. <dl class="params"><dt>Parameters</dt><dd>
  395. <table class="params">
  396. <tr><td class="paramname">filename</td><td>The file's name to open in current zip file </td></tr>
  397. </table>
  398. </dd>
  399. </dl>
  400. <dl class="section return"><dt>Returns</dt><dd>The file stream ID as an integer or zero on failure. </dd></dl>
  401. </div>
  402. </div>
  403. <a class="anchor" id="a19929a27566f853b38b9d184156ee350"></a>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">int openFileForWrite </td>
  409. <td>(</td>
  410. <td class="paramtype">filename&#160;</td>
  411. <td class="paramname"></td><td>)</td>
  412. <td></td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Open a file within the zip for writing </p>
  417. <dl class="params"><dt>Parameters</dt><dd>
  418. <table class="params">
  419. <tr><td class="paramname">filename</td><td>The file's name to open in current zip file </td></tr>
  420. </table>
  421. </dd>
  422. </dl>
  423. <dl class="section return"><dt>Returns</dt><dd>The file stream ID as an integer or 0 on failure. </dd></dl>
  424. </div>
  425. </div>
  426. <h2 class="groupheader">Member Data Documentation</h2>
  427. <a class="anchor" id="a6521cd7227b2239fa4c2168ce1fa8d10"></a>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname">struct { ... } gModeMap[]</td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <b>Initial value:</b><div class="fragment"><div class="line">=</div>
  437. <div class="line">{</div>
  438. <div class="line"> { <span class="stringliteral">&quot;read&quot;</span>, Zip::ZipArchive::Read },</div>
  439. <div class="line"> { <span class="stringliteral">&quot;write&quot;</span>, Zip::ZipArchive::Write },</div>
  440. <div class="line"> { <span class="stringliteral">&quot;readwrite&quot;</span>, Zip::ZipArchive::ReadWrite },</div>
  441. <div class="line"> { NULL, (Zip::ZipArchive::AccessMode)0 }</div>
  442. <div class="line">}</div>
  443. </div><!-- fragment -->
  444. </div>
  445. </div>
  446. <a class="anchor" id="ac6c3dfb4c3a68f849f32cbfb21da4e77"></a>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">Zip::ZipArchive::AccessMode mode</td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. </div>
  456. </div>
  457. <a class="anchor" id="ab9eced2c5fab5729cc642106eaf65d9a"></a>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">const char* strMode</td>
  463. </tr>
  464. </table>
  465. </div><div class="memdoc">
  466. </div>
  467. </div>
  468. </div><!-- contents -->
  469. <!-- start footer part -->
  470. <hr class="footer"/><address class="footer"><small>
  471. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  472. <img class="footer" src="doxygen.png" alt="doxygen"/>
  473. </a> 1.8.3.1
  474. </small></address>
  475. </body>
  476. </html>