TorqueEngine
/
Torque2D
огледало од https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
							<!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: FileObject 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classFileObject-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FileObject 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:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3884c449ed57d44137e95dd639122220"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a3884c449ed57d44137e95dd639122220">isEOF</a> ()</td></tr>
<tr class="separator:a3884c449ed57d44137e95dd639122220"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fdf8da013f61c1621e3e9633d1629c7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a6fdf8da013f61c1621e3e9633d1629c7">openForAppend</a> (filename)</td></tr>
<tr class="separator:a6fdf8da013f61c1621e3e9633d1629c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad853453a27a859504f562f24d0938de2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a> (filename)</td></tr>
<tr class="separator:ad853453a27a859504f562f24d0938de2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83d458638a758f874fcf5ee82946d9b8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a83d458638a758f874fcf5ee82946d9b8">openForWrite</a> (filename)</td></tr>
<tr class="separator:a83d458638a758f874fcf5ee82946d9b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab929d2845972401bc74ac6aa2d5e44"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a0ab929d2845972401bc74ac6aa2d5e44">peekLine</a> ()</td></tr>
<tr class="separator:a0ab929d2845972401bc74ac6aa2d5e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a723d8ab1b4f3966a0e95043c20d8fa71"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a723d8ab1b4f3966a0e95043c20d8fa71">readLine</a> ()</td></tr>
<tr class="separator:a723d8ab1b4f3966a0e95043c20d8fa71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2895edc4ecc01bf24d1c2166084e77f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a2895edc4ecc01bf24d1c2166084e77f7">writeLine</a> (text)</td></tr>
<tr class="separator:a2895edc4ecc01bf24d1c2166084e77f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b2d3fbeea8517d038208d362cb6b378"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a2b2d3fbeea8517d038208d362cb6b378">writeObject</a> (<a class="el" href="classSimObject.html">SimObject</a>, object prepend)</td></tr>
<tr class="separator:a2b2d3fbeea8517d038208d362cb6b378"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</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">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the close method to close the current file handle. If the file was opened for writing, this flushes the contents of the last write to disk. </p>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a6fdf8da013f61c1621e3e9633d1629c7">openForAppend</a>, <a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a>, <a class="el" href="classFileObject.html#a83d458638a758f874fcf5ee82946d9b8">openForWrite</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a3884c449ed57d44137e95dd639122220"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isEOF </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the isEOF method to check to see if the end of the current file (opened for read) has been reached. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the end of file has been reached, false otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a6fdf8da013f61c1621e3e9633d1629c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool openForAppend </td>
          <td>(</td>
          <td class="paramtype">filename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the openForAppend method to open a previously created file for appending. If the file specified by filename does not exist, the file is created first. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The path and filename of the file to open for appending. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for appending, false otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>, <a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a>, <a class="el" href="classFileObject.html#a83d458638a758f874fcf5ee82946d9b8">openForWrite</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ad853453a27a859504f562f24d0938de2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool openForRead </td>
          <td>(</td>
          <td class="paramtype">filename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the openForRead method to open a previously created file for reading. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The path and filename of the file to open for reading. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for reading, false otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>, OpenForAppend, OpenForWrite </dd></dl>

</div>
</div>
<a class="anchor" id="a83d458638a758f874fcf5ee82946d9b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool openForWrite </td>
          <td>(</td>
          <td class="paramtype">filename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the openForWrite method to previously created or a new file for writing. In either case, the file will be overwritten. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The path and filename of the file to open for writing. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for writing, false otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>, OpenForAppend, <a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a0ab929d2845972401bc74ac6aa2d5e44"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string peekLine </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Read a line from the file without moving the stream position. </p>

</div>
</div>
<a class="anchor" id="a723d8ab1b4f3966a0e95043c20d8fa71"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string readLine </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the readLine method to read a single line from a file previously opened for reading. Use isEOF to check for end of file while reading. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns the next line in the file, or a NULL string if the end-of-file has been reached. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a3884c449ed57d44137e95dd639122220">isEOF</a>, <a class="el" href="classFileObject.html#ad853453a27a859504f562f24d0938de2">openForRead</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a2895edc4ecc01bf24d1c2166084e77f7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void writeLine </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the writeLine method to write a value ( text ) into a file that was previously opened for appending or over-writing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>The value to write to the file. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a6fdf8da013f61c1621e3e9633d1629c7">openForAppend</a>, <a class="el" href="classFileObject.html#a83d458638a758f874fcf5ee82946d9b8">openForWrite</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a2b2d3fbeea8517d038208d362cb6b378"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void writeObject </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">object&#160;</td>
          <td class="paramname"><em>prepend</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>