NclBase Class Reference

#include <NclBase.h>

Inheritance diagram for NclBase:

Inheritance graph
[legend]
Collaboration diagram for NclBase:

Collaboration graph
[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 38 of file NclBase.h.

Public Member Functions

 NclBase (void)
 NclBase (wxString name)
 ~NclBase (void)
bool ReturnDebug (void)
void SetDebug (void)
void UnsetDebug (void)
void PrintSerialNumber ()
unsigned long GetSerialNumber ()
wxString GetSerialNumberString ()

Private Attributes

int serialNumber
wxString myName

Constructor & Destructor Documentation

NclBase::NclBase (  void   ) 
 

Parameters:
void 
Returns:

Definition at line 21 of file NclBase.cpp.

References NclLog::Creation(), myName, serialNumber, SetDebug(), and UnsetDebug(). 

00022 {
00023   serialNumber = NCL_SERIAL_NUMBER++; 
00024 #ifdef _TRACK_BASE
00025   MyLog->Creation( "NclBase", this );
00026 #endif
00027 #ifdef _DEBUG
00028   SetDebug();
00029 #else
00030   UnsetDebug();
00031 #endif
00032   myName = "";
00033 }

NclBase::NclBase (  wxString  name  ) 
 

Parameters:
name 
Returns:

Definition at line 35 of file NclBase.cpp.

References NclLog::Creation(), myName, serialNumber, SetDebug(), and UnsetDebug(). 

00036 {
00037   serialNumber = NCL_SERIAL_NUMBER++; 
00038 #ifdef _TRACK_BASE
00039   MyLog->Creation( "NclBase", this );
00040 #endif
00041 #ifdef _DEBUG
00042   SetDebug();
00043 #else
00044   UnsetDebug();
00045 #endif
00046   myName = name;
00047 }

NclBase::~NclBase (  void   ) 
 

Parameters:
void 
Returns:

Definition at line 49 of file NclBase.cpp.

References NclLog::Destruction(). 

00050 {
00051 #ifdef _TRACK_BASE
00052   MyLog->Destruction( "NclBase", this );
00053 #endif
00054 }

Member Function Documentation

unsigned long NclBase::GetSerialNumber (   ) 
 

Return the serial number as an unsigned long.

Parameters:
void 
Returns:

Definition at line 82 of file NclBase.cpp.

References serialNumber. 

00084 {
00085   return(serialNumber);
00086 }

wxString NclBase::GetSerialNumberString (   ) 
 

Return the serial number as a wxString.

Parameters:
void 
Returns:

Definition at line 88 of file NclBase.cpp.

References serialNumber.

Referenced by NclLog::Creation(), NclLog::Destruction(), and NclCanvas::OnDraw(). 

00090 {
00091   wxString rv;
00092     rv.Printf( "%d", serialNumber );
00093   return rv;
00094 }

void NclBase::PrintSerialNumber (   ) 
 

Print the serial number on cerr.

Parameters:
void 
Returns:

Definition at line 74 of file NclBase.cpp.

References myName, ReturnDebug(), and serialNumber. 

00076 {
00077   if ( ReturnDebug() )
00078     cerr << "\n" << myName << "." << serialNumber << " Serial number ";
00079 }

bool NclBase::ReturnDebug (  void   ) 
 

Parameters:
void 
Returns:

Definition at line 61 of file NclBase.cpp.

Referenced by PrintSerialNumber(). 

00062 {
00063   return true;
00064 }

void NclBase::SetDebug (  void   ) 
 

Parameters:
void 
Returns:

Reimplemented in MdoADT.

Definition at line 66 of file NclBase.cpp.

Referenced by NclBase(). 

00067 {
00068 }

void NclBase::UnsetDebug (  void   ) 
 

Parameters:
void 
Returns:

Reimplemented in MdoADT.

Definition at line 70 of file NclBase.cpp.

Referenced by NclBase(). 

00071 {
00072 }

Member Data Documentation

wxString NclBase::myName [private]
 

Definition at line 104 of file NclBase.h.

Referenced by NclBase(), and PrintSerialNumber().

int NclBase::serialNumber [private]
 

Definition at line 99 of file NclBase.h.

Referenced by GetSerialNumber(), GetSerialNumberString(), NclBase(), and PrintSerialNumber().

Generated on Wed Sep 28 11:10:45 2005 for NClip by doxygen 1.3.1 using KingsTools