summaryrefslogtreecommitdiff
path: root/docs/module-doc/classFileReader.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-20 15:48:27 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-20 15:48:27 +0000
commit2db0df5813e46fe5e077e014003acbd10698b913 (patch)
tree8d18035c30623c3dcd677c2b93fd832e6cb3d09d /docs/module-doc/classFileReader.html
parent15228d509a36036af6d8ab1f63f0ccbc0eeb0c3d (diff)
Added module message passing architecture
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1136 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classFileReader.html')
-rw-r--r--docs/module-doc/classFileReader.html96
1 files changed, 48 insertions, 48 deletions
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
index 27989604a..ffccc4d37 100644
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l01033">1033</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+Definition at line <a class="el" href="modules_8h-source.html#l01161">1161</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="FileReader::FileReader"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -77,10 +77,10 @@ Default constructor.
<p>
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00915">915</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00986">986</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00916 {
-00917 }
+<div class="fragment"><pre>00987 {
+00988 }
</pre></div> </td>
</tr>
</table>
@@ -114,15 +114,15 @@ Secondary constructor.
<p>
This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00908">908</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00979">979</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01035">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l01163">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
<p>
-<div class="fragment"><pre>00909 {
-00910 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
-00911 readfile(c,filename.c_str());
-00912 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
-00913 }
+<div class="fragment"><pre>00980 {
+00981 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
+00982 readfile(c,filename.c_str());
+00983 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
+00984 }
</pre></div> </td>
</tr>
</table>
@@ -155,10 +155,10 @@ Default destructor.
<p>
This deletes the memory allocated to the file.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00927">927</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00998">998</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00928 {
-00929 }
+<div class="fragment"><pre>00999 {
+01000 }
</pre></div> </td>
</tr>
</table>
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul
<p>
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00931">931</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l01002">1002</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01035">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01163">fc</a>.
<p>
-<div class="fragment"><pre>00932 {
-00933 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0)
-00934 {
-00935 <span class="keywordflow">return</span>(<span class="keyword">false</span>);
-00936 }
-00937 <span class="keywordflow">else</span>
-00938 {
-00939 <span class="keywordflow">return</span>(<span class="keyword">true</span>);
-00940 }
-00941 }
+<div class="fragment"><pre>01003 {
+01004 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#r0">fc</a>.size() == 0)
+01005 {
+01006 <span class="keywordflow">return</span>(<span class="keyword">false</span>);
+01007 }
+01008 <span class="keywordflow">else</span>
+01009 {
+01010 <span class="keywordflow">return</span>(<span class="keyword">true</span>);
+01011 }
+01012 }
</pre></div> </td>
</tr>
</table>
@@ -238,13 +238,13 @@ Returns the size of the file in lines.
<p>
This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00950">950</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l01021">1021</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01035">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01163">fc</a>.
<p>
-<div class="fragment"><pre>00951 {
-00952 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size();
-00953 }
+<div class="fragment"><pre>01022 {
+01023 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>.size();
+01024 }
</pre></div> </td>
</tr>
</table>
@@ -278,15 +278,15 @@ Retrieve one line from the file.
<p>
This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00943">943</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l01014">1014</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01035">fc</a>.
+References <a class="el" href="modules_8h-source.html#l01163">fc</a>.
<p>
-<div class="fragment"><pre>00944 {
-00945 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#r0">fc</a>.size()))
-00946 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00947 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x];
-00948 }
+<div class="fragment"><pre>01015 {
+01016 <span class="keywordflow">if</span> ((x&lt;0) || (x&gt;<a class="code" href="classFileReader.html#r0">fc</a>.size()))
+01017 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+01018 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#r0">fc</a>[x];
+01019 }
</pre></div> </td>
</tr>
</table>
@@ -320,15 +320,15 @@ Used to load a file.
<p>
This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00919">919</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00990">990</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l01035">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l01163">fc</a>, and <a class="el" href="modules_8h-source.html#l00067">file_cache</a>.
<p>
-<div class="fragment"><pre>00920 {
-00921 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
-00922 readfile(c,filename.c_str());
-00923 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
-00924 }
+<div class="fragment"><pre>00991 {
+00992 <a class="code" href="modules_8h.html#a31">file_cache</a> c;
+00993 readfile(c,filename.c_str());
+00994 this-&gt;<a class="code" href="classFileReader.html#r0">fc</a> = c;
+00995 }
</pre></div> </td>
</tr>
</table>
@@ -354,14 +354,14 @@ References <a class="el" href="modules_8h-source.html#l01035">fc</a>, and <a cla
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l01035">1035</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l01163">1163</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00931">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00908">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00950">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00943">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00919">LoadFile()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l01002">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00979">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l01021">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l01014">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00990">LoadFile()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Sat Apr 16 18:57:17 2005 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:47:03 2005 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>