diff options
Diffstat (limited to 'docs/man/man3/FileReader.3')
| -rw-r--r-- | docs/man/man3/FileReader.3 | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 05fbaae25..f9688416d 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -57,7 +57,7 @@ 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. .PP -Definition at line 1614 of file modules.h. +Definition at line 1618 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" @@ -66,11 +66,11 @@ Default constructor. .PP This method does not load any file into memory, you must use the LoadFile method after constructing the class this way. .PP -Definition at line 889 of file modules.cpp. +Definition at line 894 of file modules.cpp. .PP .nf -890 { -891 } +895 { +896 } .fi .PP .SS "FileReader::FileReader (\fBstd::string\fP filename)" @@ -79,16 +79,16 @@ Secondary constructor. .PP 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, \fBFileReader::FileSize\fP returns 0. .PP -Definition at line 882 of file modules.cpp. +Definition at line 887 of file modules.cpp. .PP References fc. .PP .nf -883 { -884 file_cache c; -885 readfile(c,filename.c_str()); -886 this->fc = c; -887 } +888 { +889 file_cache c; +890 readfile(c,filename.c_str()); +891 this->fc = c; +892 } .fi .PP .SS "FileReader::~FileReader ()" @@ -97,11 +97,11 @@ Default destructor. .PP This deletes the memory allocated to the file. .PP -Definition at line 901 of file modules.cpp. +Definition at line 906 of file modules.cpp. .PP .nf -902 { -903 } +907 { +908 } .fi .PP .SH "Member Function Documentation" @@ -110,21 +110,21 @@ Definition at line 901 of file modules.cpp. .PP Returns true if the file exists This function will return false if the file could not be opened. .PP -Definition at line 905 of file modules.cpp. +Definition at line 910 of file modules.cpp. .PP References fc. .PP .nf -906 { -907 if (fc.size() == 0) -908 { -909 return(false); -910 } -911 else -912 { -913 return(true); -914 } -915 } +911 { +912 if (fc.size() == 0) +913 { +914 return(false); +915 } +916 else +917 { +918 return(true); +919 } +920 } .fi .PP .SS "int FileReader::FileSize ()" @@ -133,14 +133,14 @@ Returns the size of the file in lines. .PP 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. .PP -Definition at line 924 of file modules.cpp. +Definition at line 929 of file modules.cpp. .PP References fc. .PP .nf -925 { -926 return fc.size(); -927 } +930 { +931 return fc.size(); +932 } .fi .PP .SS "\fBstd::string\fP FileReader::GetLine (int x)" @@ -149,16 +149,16 @@ Retrieve one line from the file. .PP 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. .PP -Definition at line 917 of file modules.cpp. +Definition at line 922 of file modules.cpp. .PP References fc. .PP .nf -918 { -919 if ((x<0) || ((unsigned)x>fc.size())) -920 return ''; -921 return fc[x]; -922 } +923 { +924 if ((x<0) || ((unsigned)x>fc.size())) +925 return ''; +926 return fc[x]; +927 } .fi .PP .SS "void FileReader::LoadFile (\fBstd::string\fP filename)" @@ -167,23 +167,23 @@ Used to load a file. .PP 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, \fBFileReader::FileSize\fP returns 0. .PP -Definition at line 893 of file modules.cpp. +Definition at line 898 of file modules.cpp. .PP References fc. .PP .nf -894 { -895 file_cache c; -896 readfile(c,filename.c_str()); -897 this->fc = c; -898 } +899 { +900 file_cache c; +901 readfile(c,filename.c_str()); +902 this->fc = c; +903 } .fi .PP .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1616 of file modules.h. +Definition at line 1620 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). |