Contents User Forum Source Index APIs by Task APIs by Level Data


G3D::Log Class Reference

System log for debugging purposes. More...

#include <Log.h>

List of all members.

Public Member Functions

FILE * getFile () const
 Log (const std::string &filename="log.txt", int stripFromStackBottom=0)
void print (const std::string &s)
void __cdecl printf (const char *fmt,...) G3D_CHECK_PRINTF_METHOD_ARGS
void println (const std::string &s)
void section (const std::string &s)
void __cdecl vprintf (const char *, va_list argPtr) G3D_CHECK_VPRINTF_METHOD_ARGS
virtual ~Log ()

Static Public Member Functions

static Logcommon ()
static std::string getCommonLogFilename ()


Detailed Description

System log for debugging purposes.

The first log opened is the "common log" and can be accessed with the static method common(). If you access common() and a common log does not yet exist, one is created for you.


Constructor & Destructor Documentation

G3D::Log::Log ( const std::string &  filename = "log.txt",
int  stripFromStackBottom = 0 
)

Parameters:
stripFromStackBottom Number of call stacks to strip from the bottom of the stack when printing a trace.

Useful for hiding routines like "main" and "WinMain". If the specified file cannot be opened for some reason, tries to open "c:/tmp/log.txt" or "c:/temp/log.txt" instead.

virtual G3D::Log::~Log (  )  [virtual]


Member Function Documentation

static Log* G3D::Log::common (  )  [static]

static std::string G3D::Log::getCommonLogFilename (  )  [static]

FILE* G3D::Log::getFile (  )  const

Returns the handle to the file log.

void G3D::Log::print ( const std::string &  s  ) 

void __cdecl G3D::Log::printf ( const char *  fmt,
  ... 
)

Given arguments like printf, writes characters to the debug text overlay.

void G3D::Log::println ( const std::string &  s  ) 

void G3D::Log::section ( const std::string &  s  ) 

Marks the beginning of a logfile section.

void __cdecl G3D::Log::vprintf ( const char *  ,
va_list  argPtr 
)


The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:46 2007 for G3D by doxygen 1.5.2
Hosted by SourceForge.net Logo