From cd9f9a8add02597a2998ba74b803ed3fbf81314c Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 27 Nov 2005 01:44:46 +0000 Subject: Added new documentation git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 249 +++++++++++++++++------------------ 1 file changed, 121 insertions(+), 128 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 3e69fe2d0..6141b3c73 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -1,77 +1,76 @@ - + -InspIRCd: FileReader class Reference +InspIRCd: FileReader Class Reference - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | 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 | Class List | Directories | File List | Namespace Members | Class 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. +
[legend]
List of all members.
- - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + +

Public Member Functions

 FileReader ()

Public Member Functions

 FileReader ()
 Default constructor.

 FileReader (std::string filename)
 Default constructor.
 FileReader (std::string filename)
 Secondary constructor.

 ~FileReader ()
 Secondary constructor.
 ~FileReader ()
 Default destructor.

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

bool Exists ()
 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)
 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 ()
 Retrieve one line from the file.
int FileSize ()
 Returns the size of the file in lines.


Private Attributes

file_cache fc
 Returns the size of the file in lines.

Private Attributes

file_cache fc

Detailed Description

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. +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 1239 of file modules.h.

Constructor & Destructor Documentation

-

- +Definition at line 1210 of file modules.h.

Constructor & Destructor Documentation

+

+

- + -
FileReader::FileReader FileReader::FileReader (   ) 
- +
+
  @@ -83,32 +82,31 @@ 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 975 of file modules.cpp. +Definition at line 950 of file modules.cpp.

00951 {
+00952 }
+

-

00976 {
-00977 }
-
-

- +

+

- + - + -
FileReader::FileReader FileReader::FileReader ( std::string std::string  filename  ) 
- +
+
  @@ -118,38 +116,37 @@ Definition at line 975

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. +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 968 of file modules.cpp. +Definition at line 943 of file modules.cpp.

-References fc, and file_cache. +References fc.

00944 {
+00945         file_cache c;
+00946         readfile(c,filename.c_str());
+00947         this->fc = c;
+00948 }
+

-

00969 {
-00970         file_cache c;
-00971         readfile(c,filename.c_str());
-00972         this->fc = c;
-00973 }
-
-

- +

+

- + -
FileReader::~FileReader FileReader::~FileReader (   ) 
- +
+
  @@ -161,32 +158,31 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 987 of file modules.cpp. +Definition at line 962 of file modules.cpp.

00963 {
+00964 }
+

-

00988 {
-00989 }
-

Member Function Documentation

-

- +

+

- + -
bool FileReader::Exists bool FileReader::Exists (   ) 
- +
+Definition at line 966 of file modules.cpp. +

+References fc.

00967 {
+00968         if (fc.size() == 0)
+00969         {
+00970                 return(false);
+00971         }
+00972         else
+00973         {
+00974                 return(true);
+00975         }
+00976 }
+
+

+

  @@ -198,41 +194,40 @@ Returns true if the file exists This function will return false if the file coul

-Definition at line 991 of file modules.cpp. -

-References fc. -

-

00992 {
-00993         if (fc.size() == 0)
-00994         {
-00995                 return(false);
-00996         }
-00997         else
-00998         {
-00999                 return(true);
-01000         }
-01001 }
-
-

- +

+

- + -
int FileReader::FileSize int FileReader::FileSize (   ) 
- +
+
  @@ -244,35 +239,34 @@ 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 1010 of file modules.cpp. +Definition at line 985 of file modules.cpp.

-References fc. +References fc.

00986 {
+00987         return fc.size();
+00988 }
+

-

01011 {
-01012         return fc.size();
-01013 }
-
-

- +

+

- + -
std::string FileReader::GetLine std::string FileReader::GetLine (  int  x  ) 
- +
+
  @@ -284,37 +278,36 @@ 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 1003 of file modules.cpp. +Definition at line 978 of file modules.cpp.

-References fc. +References fc.

00979 {
+00980         if ((x<0) || ((unsigned)x>fc.size()))
+00981                 return "";
+00982         return fc[x];
+00983 }
+

-

01004 {
-01005         if ((x<0) || (x>fc.size()))
-01006                 return "";
-01007         return fc[x];
-01008 }
-
-

- +

+

- + - + -
void FileReader::LoadFile void FileReader::LoadFile ( std::string std::string  filename  ) 
- +
+
  @@ -324,33 +317,34 @@ References fc.

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. +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 979 of file modules.cpp. +Definition at line 954 of file modules.cpp.

-References fc, and file_cache. +References fc.

00955 {
+00956         file_cache c;
+00957         readfile(c,filename.c_str());
+00958         this->fc = c;
+00959 }
+

-

00980 {
-00981         file_cache c;
-00982         readfile(c,filename.c_str());
-00983         this->fc = c;
-00984 }
-

Member Data Documentation

-

- +

+

- +
file_cache FileReader::fc [private] + file_cache FileReader::fc [private]
- +
+Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
  @@ -360,16 +354,15 @@ References fc, and

-Definition at line 1241 of file modules.h. +Definition at line 1212 of file modules.h.

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

The documentation for this class was generated from the following files: -
Generated on Mon May 30 05:17:01 2005 for InspIRCd by +
Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by  -doxygen -1.3.3
+doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91