From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 241 ++++++++++++++++++----------------- 1 file changed, 121 insertions(+), 120 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 8cbb5d3ea..952b8dcb8 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -1,62 +1,63 @@ -FileReader class Reference +InspIRCd: FileReader class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

FileReader Class Reference

Caches a text file into memory and can be used to retrieve lines from it. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

FileReader Class Reference

Caches a text file into memory and can be used to retrieve lines from it. More...

#include <modules.h>

-Inheritance diagram for FileReader:

Inheritance graph
- - - -
[legend]
Collaboration diagram for FileReader:

Collaboration graph
- - - -
[legend]
List of all members. +Inherits classbase. +

+List of all members.

- - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - + +

Public Member Functions

 FileReader ()
 Default constructor.

 FileReader (std::string filename)
 Secondary constructor.

 ~FileReader ()
 Default destructor.

void LoadFile (std::string filename)
 Used to load a file.

bool Exists ()
 Returns true if the file exists This function will return false if the file could not be opened.

std::string GetLine (int x)
 Retrieve one line from the file.

int FileSize ()
 Returns the size of the file in lines.

 FileReader ()
 Default constructor.

 FileReader (std::string filename)
 Secondary constructor.

 ~FileReader ()
 Default destructor.

void LoadFile (std::string filename)
 Used to load a file.

bool Exists ()
 Returns true if the file exists This function will return false if the file could not be opened.

std::string GetLine (int x)
 Retrieve one line from the file.

int FileSize ()
 Returns the size of the file in lines.


Private Attributes

file_cache fc
file_cache fc

Detailed Description

-Caches a text file into memory and can be used to retrieve lines from it. +Caches a text file into memory and can be used to retrieve lines from it.

This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.

-Definition at line 699 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 730 of file modules.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -72,28 +73,28 @@ Definition at line 699 of
FileReader::FileReader (   )   ) 

-Default constructor. +Default constructor.

This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

-Definition at line 670 of file modules.cpp. +Definition at line 719 of file modules.cpp.

-

00671 {
-00672 }
+
00720 {
+00721 }

- +
-
+ - - + + @@ -109,32 +110,32 @@ Definition at line 670
FileReader::FileReader (  std::string   filename )  filename  ) 

-Secondary constructor. +Secondary constructor.

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, FileReader::FileSize returns 0.

-Definition at line 663 of file modules.cpp. +Definition at line 712 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00664 {
-00665         file_cache c;
-00666         readfile(c,filename.c_str());
-00667         this->fc = c;
-00668 }
+
00713 {
+00714         file_cache c;
+00715         readfile(c,filename.c_str());
+00716         this->fc = c;
+00717 }

- +
-
+ - + - - + + @@ -150,28 +151,28 @@ References fc, and

-Default destructor. +Default destructor.

This deletes the memory allocated to the file.

-Definition at line 682 of file modules.cpp. +Definition at line 731 of file modules.cpp.

-

00683 {
-00684 }
+
00732 {
+00733 }
FileReader::~FileReader FileReader::~FileReader (   )   ) 

Member Function Documentation

- +
-
+ - - + + @@ -187,37 +188,37 @@ Definition at line 682
bool FileReader::Exists (   )   ) 

-Returns true if the file exists This function will return false if the file could not be opened. +Returns true if the file exists This function will return false if the file could not be opened.

-Definition at line 686 of file modules.cpp. +Definition at line 735 of file modules.cpp.

-References fc. +References fc.

-

00687 {
-00688         if (fc.size() == 0)
-00689         {
-00690                 return(false);
-00691         }
-00692         else
-00693         {
-00694                 return(true);
-00695         }
-00696 }
+
00736 {
+00737         if (fc.size() == 0)
+00738         {
+00739                 return(false);
+00740         }
+00741         else
+00742         {
+00743                 return(true);
+00744         }
+00745 }

- +
-
+ - - + + @@ -233,31 +234,31 @@ References fc.
int FileReader::FileSize (   )   ) 

-Returns the size of the file in lines. +Returns the size of the file in lines.

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.

-Definition at line 705 of file modules.cpp. +Definition at line 754 of file modules.cpp.

-References fc. +References fc.

-

00706 {
-00707         return fc.size();
-00708 }
+
00755 {
+00756         return fc.size();
+00757 }

- +
-
+ - - + + @@ -273,33 +274,33 @@ References fc.
std::string FileReader::GetLine (  int   x )  x  ) 

-Retrieve one line from the file. +Retrieve one line from the file.

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.

-Definition at line 698 of file modules.cpp. +Definition at line 747 of file modules.cpp.

-References fc. +References fc.

-

00699 {
-00700         if ((x<0) || (x>fc.size()))
-00701                 return "";
-00702         return fc[x];
-00703 }
+
00748 {
+00749         if ((x<0) || (x>fc.size()))
+00750                 return "";
+00751         return fc[x];
+00752 }

- +
-
+ - - + + @@ -315,30 +316,30 @@ References fc.
void FileReader::LoadFile (  std::string   filename )  filename  ) 

-Used to load a file. +Used to load a file.

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, FileReader::FileSize returns 0.

-Definition at line 674 of file modules.cpp. +Definition at line 723 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00675 {
-00676         file_cache c;
-00677         readfile(c,filename.c_str());
-00678         this->fc = c;
-00679 }
+
00724 {
+00725         file_cache c;
+00726         readfile(c,filename.c_str());
+00727         this->fc = c;
+00728 }

Member Data Documentation

-

- +

+

- @@ -353,16 +354,16 @@ References fc, and

-Definition at line 701 of file modules.h. +Definition at line 732 of file modules.h.

-Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().

+ -
file_cache FileReader::fc [private] + file_cache FileReader::fc [private]

The documentation for this class was generated from the following files: -
Generated on Sun May 2 00:09:36 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
-- cgit v1.3.1-10-gc9f91