TLogFile Class Reference

This class is designed for logging program run into specified file. More...

#include <LogFile.h>

Inheritance diagram for TLogFile:

Inheritance graph
[legend]
Collaboration diagram for TLogFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TLogFile (void)
 Initializing constructor.
 ~TLogFile (void)
 Destructor.
BOOL Open (const TString &filename)
 This method open specified file as log file.
void Close (void)
 This method close specified file.
BOOL IsOpened (void) const
void Write (const char *str) const
 Write specified string into log file.
void WriteNewLine (void) const
 Writes new line to output.
void WriteTime (void) const
 Writes into file actual time in format "HH:MM:SS".
void WriteDate (void) const
 Writes into file actual date in format "YYYY-MM-DD".
void WriteDateTime (void) const
 Writes actual date and time into file.
void WriteSTRING (const char *str) const
 Write string into file.
void WriteSTRING (const TString &str) const
 Write string into file.
void WriteINT (const int &value) const
 Write integer into file as text.
void WriteUINT (const UINT &value) const
 Write unsigned integer into file as text.
void WriteDWORD (const DWORD &value) const
 Write DWORD into file as text.
void WriteFLOAT (const float &value) const
 Write FLOAT into file as text.
void WriteDOUBLE (const double &value) const
 Write DOUBLE into file as text.
void WriteBYTE (const BYTE &value) const
 Write BYTE into file as text.
void WriteCHAR (const CHAR &value) const
 Write CHAR into file as text.
void WriteWORD (const WORD &value) const
 Write WORD into file as text.
void WriteSHORT (const SHORT &value) const
 Write SHORT into file as text.
void WritePointer (const void *ptr) const
 Write pointer (address) to file as text.
void WritePointerHex (const void *ptr) const
 Write pointer (address) to file as text in hexadecimal mode.

Detailed Description

This class is designed for logging program run into specified file.

Obviously this file is one per program and it logs important messages into it.

Final (output) file is in ASCII text mode. Writing to it is in translated mode (
means 0x13 0x10 on WIN etc.)

Definition at line 30 of file LogFile.h.


Constructor & Destructor Documentation

TLogFile::TLogFile void   )  [inline]
 

Initializing constructor.

Definition at line 42 of file LogFile.h.

TLogFile::~TLogFile void   )  [inline]
 

Destructor.

Automatically close file.

Definition at line 46 of file LogFile.h.

References Close().

Here is the call graph for this function:


Member Function Documentation

void TLogFile::Close void   ) 
 

This method close specified file.

If no file inside object is opened nothing is happen.

Definition at line 42 of file LogFile.cpp.

Referenced by ~TLogFile().

BOOL TLogFile::IsOpened void   )  const [inline]
 

Definition at line 54 of file LogFile.h.

BOOL TLogFile::Open const TString filename  ) 
 

This method open specified file as log file.

If item exists then it is overwrite. Otherwise new file is created.

If some file inside object is already open no action is performed and TRUE is returned.

On error FALSE is returned.

Parameters:
filename [in] name of file to created or open

Definition at line 28 of file LogFile.cpp.

References TString::GetString(), and TRUE.

Here is the call graph for this function:

void TLogFile::Write const char *  str  )  const
 

Write specified string into log file.

Parameters:
str [in] string ended with zero

Definition at line 55 of file LogFile.cpp.

Referenced by TGlobalsSystem::Destroy(), and WinMain().

void TLogFile::WriteBYTE const BYTE value  )  const
 

Write BYTE into file as text.

Parameters:
value [in] specified value

Definition at line 169 of file LogFile.cpp.

void TLogFile::WriteCHAR const CHAR value  )  const
 

Write CHAR into file as text.

Parameters:
value [in] specified value

Definition at line 178 of file LogFile.cpp.

void TLogFile::WriteDate void   )  const
 

Writes into file actual date in format "YYYY-MM-DD".

Definition at line 80 of file LogFile.cpp.

void TLogFile::WriteDateTime void   )  const
 

Writes actual date and time into file.

Format is "YYYY-MM-DD HH:MM:SS".

Definition at line 92 of file LogFile.cpp.

void TLogFile::WriteDOUBLE const double &  value  )  const
 

Write DOUBLE into file as text.

Parameters:
value [in] specified value

Definition at line 160 of file LogFile.cpp.

void TLogFile::WriteDWORD const DWORD value  )  const
 

Write DWORD into file as text.

Parameters:
value [in] specified value

Definition at line 142 of file LogFile.cpp.

void TLogFile::WriteFLOAT const float &  value  )  const
 

Write FLOAT into file as text.

Parameters:
value [in] specified value

Definition at line 151 of file LogFile.cpp.

void TLogFile::WriteINT const int &  value  )  const
 

Write integer into file as text.

Parameters:
value [in] specified value

Definition at line 124 of file LogFile.cpp.

Referenced by TGlobalsSystem::Destroy().

void TLogFile::WriteNewLine void   )  const
 

Writes new line to output.

Definition at line 62 of file LogFile.cpp.

Referenced by TGlobalsSystem::Destroy().

void TLogFile::WritePointer const void *  ptr  )  const
 

Write pointer (address) to file as text.

Parameters:
ptr [in] specified pointer

Definition at line 205 of file LogFile.cpp.

void TLogFile::WritePointerHex const void *  ptr  )  const
 

Write pointer (address) to file as text in hexadecimal mode.

Parameters:
ptr [in] specified pointer

Definition at line 214 of file LogFile.cpp.

void TLogFile::WriteSHORT const SHORT value  )  const
 

Write SHORT into file as text.

Parameters:
value [in] specified value

Definition at line 196 of file LogFile.cpp.

void TLogFile::WriteSTRING const TString str  )  const
 

Write string into file.

Parameters:
str [in] specified string

Definition at line 115 of file LogFile.cpp.

References TString::c_str().

Here is the call graph for this function:

void TLogFile::WriteSTRING const char *  str  )  const
 

Write string into file.

Parameters:
str [in] specified string

Definition at line 106 of file LogFile.cpp.

void TLogFile::WriteTime void   )  const
 

Writes into file actual time in format "HH:MM:SS".

Definition at line 69 of file LogFile.cpp.

void TLogFile::WriteUINT const UINT value  )  const
 

Write unsigned integer into file as text.

Parameters:
value [in] specified value

Definition at line 133 of file LogFile.cpp.

void TLogFile::WriteWORD const WORD value  )  const
 

Write WORD into file as text.

Parameters:
value [in] specified value

Definition at line 187 of file LogFile.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Nov 28 22:42:56 2007 for Joy4D by  doxygen 1.4.6-NO