NclLog Class Reference

#include <NclLog.h>

Collaboration diagram for NclLog:

[legend]List of all members.

---

Detailed Description

requirements

GNU C++ Compatible Compiler or MS Compiler
win2k or later
WxWidgets 2.6

Version:

1.0 first version

Date:

09-08-2005

Author:

kamp

license

This code is absolutely free to use and modify. The code is provided "as is" with no expressed or implied warranty. The author accepts no liability if it causes any damage to your computer, causes your pet to fall ill, increases baldness or makes your car start emitting strange noises when you start it up. This code has no bugs, just undocumented features!

Todo:

Bug:

Definition at line 35 of file NclLog.h.

Public Member Functions
	NclLog (void)
	NclLog (wxString name)
virtual	~NclLog (void)
void	Clear ()
bool	Line (wxString message)
bool	Line (wxString format, wxString message)
bool	Line (wxString format, long number)
bool	Line (wxString format, long number1, long number2)
void	Creation (wxString name, NclBase *base)
void	Destruction (wxString name, NclBase *base)
Private Member Functions
void	Open ()
wxString	DateTime (wxString message)
Private Attributes
wxString	logFileName
FILE *	logFilePtr

---

Constructor & Destructor Documentation

NclLog::NclLog (  void   )

Use the default name for the log file. The default name is NClip.log if the current directory. Parameters: void  Returns: Definition at line 8 of file NclLog.cpp. References Open(). { logFileName= "NClip.log"; Open( ); }

NclLog::NclLog (  wxString  name  )

Provide the name of the log file. Parameters: name  Returns: Definition at line 14 of file NclLog.cpp. References Open(). { logFileName = name; Open( ); }

NclLog::~NclLog (  void   )  [virtual]

Close the log. Parameters: void  Returns: Definition at line 20 of file NclLog.cpp. References Line(). { wxString m = "--------------------------------------------"; m.Append( "Close the log file." ); Line( m ); fclose ( logFilePtr ); }

---

Member Function Documentation

void NclLog::Clear (   )

Clear the log Definition at line 36 of file NclLog.cpp. References Line(). { fclose ( logFilePtr ); logFilePtr = fopen ( logFileName, "w" ); wxString m = "The log file was cleared."; Line( m ); }

void NclLog::Creation (  wxString  name, NclBase *  base )

Log the creation of an object. Parameters: name  *base  Definition at line 104 of file NclLog.cpp. References NclBase::GetSerialNumberString(), and Line(). Referenced by NclSession::Init(), NclCanvas::Init(), Mdo::Mdo(), NclBase::NclBase(), NclFileParser::NclFileParser(), NclFrame::NclFrame(), NclGridFromText::NclGridFromText(), NclSplitterWindow::NclSplitterWindow(), and NclTemplateClass::NclTemplateClass(). { wxString m = "#"; m.Append ( " " ); m.Append( base->GetSerialNumberString()); m.Append( " " ); m.Append ( name ); m.Append( " Created."); Line( m ); }

wxString NclLog::DateTime (  wxString  message  )  [private]

Return the Date and Time as a wxString. Parameters: message  Returns: Definition at line 89 of file NclLog.cpp. Referenced by Line(). { // Add the current date and time to the wxString. wxString m = ""; time_t rawtime; struct tm * timeinfo; time ( &rawtime ); timeinfo = localtime ( &rawtime ); wxString dt = asctime( timeinfo ); m.Append(dt.Left( (dt.Len()-1))); m.Append ( " " ); m.Append( message ); return m; }

void NclLog::Destruction (  wxString  name, NclBase *  base )

Log the destruction of an object. Parameters: name  *base  Definition at line 115 of file NclLog.cpp. References NclBase::GetSerialNumberString(), and Line(). Referenced by NclSession::Clean(), NclFrame::Clean(), Mdo::~Mdo(), NclBase::~NclBase(), NclFileParser::~NclFileParser(), NclGridFromText::~NclGridFromText(), and NclTemplateClass::~NclTemplateClass(). { wxString m = "#"; m.Append ( " " ); m.Append( base->GetSerialNumberString()); m.Append ( " " ); m.Append ( name ); m.Append( " Destroyed."); Line( m ); }

bool NclLog::Line (  wxString  format, long  number1, long  number2 )

Add two longs to the log, using the given format. Parameters: format  message  Returns: Definition at line 78 of file NclLog.cpp. References DateTime(). { wxString m = DateTime( mIn ); bool rv = true; int rl = fprintf( logFilePtr, "%s %d %d\n", m.c_str(), number1, number2 ); if ( rl < 0 ) { rv = false; } return rv; }

bool NclLog::Line (  wxString  format, long  number )

Add a long to the log, using the given format. Parameters: format  message  Returns: Definition at line 67 of file NclLog.cpp. References DateTime(). { wxString m = DateTime( mIn ); bool rv = true; int rl = fprintf( logFilePtr, "%s %d\n", m.c_str(), number ); if ( rl < 0 ) { rv = false; } return rv; }

bool NclLog::Line (  wxString  format, wxString  message )

Add a line to the log, using the given format. Parameters: format  message  Returns: Definition at line 56 of file NclLog.cpp. References DateTime(). { wxString m = DateTime( mIn ); bool rv = true; int rl = fprintf( logFilePtr, format, m.c_str() ); if ( rl < 0 ) { rv = false; } return rv; }

bool NclLog::Line (  wxString  message  )

Add a line as a string to the log. Parameters: message  Returns: Definition at line 45 of file NclLog.cpp. References DateTime(). Referenced by Clear(), NclSession::Close(), Creation(), Destruction(), Open(), NclFileManager::OpenGraphicFile(), NclFileManager::OpenTextFile(), NclFileManager::OpenXmlFile(), NclSession::SaveInCache(), NclSession::SaveInPlace(), NclGridFromText::SetNolColHeader(), NclGridFromText::SetNolHeader(), NclGridFromText::SetNolTrailer(), and ~NclLog(). { wxString m = DateTime( mIn ); bool rv = true; int rl = fprintf( logFilePtr, "%s\n", m.c_str() ); if ( rl < 0 ) { rv = false; } return rv; }

void NclLog::Open (   )  [private]

Open the log. This also writes an opening declaration to the log along with the date and time. Definition at line 28 of file NclLog.cpp. References Line(). Referenced by NclLog(). { logFilePtr = fopen( logFileName, "a" ); wxString m = "++++++++++++++++++++++++++++++++++++++++++++"; m.Append( "Open the log file." ); Line( m ); }

---