CDebugOut Class Reference

Debug output. More...

#include <debugOut.h>

List of all members.

Public Types

enum  eType { kNote, kError, kWarning }
 Type code enums. More...

Static Public Member Functions

static CDebugOut * instance ()
 
Returns:
A pointer to the singlton instance.

static void close ()
 Close output file.
GE debug output methods
static void write (const CGameEntity *pGE, const char *strAction, eType type=kNote)
static void write (const CGameEntity *pGE, const char *strAction, const EDIT_DATA &editData, eType type=kNote)
static void write (const CGameEntity *pGE, const char *strAction, const ACTION_DATA &actData, eType type=kNote)
GE debug output methods
static void write (const char *strFunc, const char *strOut, eType type=kNote)
static void write (const char *strFunc, const char *strOut, const char *str, eType type=kNote)

Detailed Description

Debug output.

Print "user readable" debug output.

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:
Doug Poston
Version:
1.3
Date:
12/28/2007

Member Enumeration Documentation

enum CDebugOut::eType

Type code enums.

Enumerator:
kNote  Note.
kError  Error (normally stops game).
kWarning  Warning.

Member Function Documentation

void CDebugOut::write ( const CGameEntity *  pGE,
const char *  strAction,
eType  type = kNote 
) [static]

Write data with GE, Action, and frame info

Parameters:
pGE GE we are reporting on.
strAction Action string.
type The type of tag (i.e. kNote, kError, kWarning).

void CDebugOut::write ( const CGameEntity *  pGE,
const char *  strAction,
const EDIT_DATA &  editData,
eType  type = kNote 
) [static]

Write data with GE and frame info

Parameters:
pGE GE we are reporting on.
strAction Action string.
editData Data to be printed.
type The type of tag (i.e. kNote, kError, kWarning).

void CDebugOut::write ( const CGameEntity *  pGE,
const char *  strAction,
const ACTION_DATA &  actData,
eType  type = kNote 
) [static]

Write data with GE and frame info

Parameters:
pGE GE we are reporting on.
strAction Action string.
actData Data to be printed.
type The type of tag (i.e. kNote, kError, kWarning).

void CDebugOut::write ( const char *  strFunc,
const char *  strOut,
eType  type = kNote 
) [static]

Write data with function name, error message, and frame info

Parameters:
strFunc Name of the function.
strOut Message text.
type The type of tag (i.e. kNote, kError, kWarning).

void CDebugOut::write ( const char *  strFunc,
const char *  strOut,
const char *  str,
eType  type = kNote 
) [static]

Write data with function name, error message, and frame info

Parameters:
strFunc Name of the function.
strOut Message text.
str Additional message text.
type The type of tag (i.e. kNote, kError, kWarning).

The documentation for this class was generated from the following files:
Generated on Fri Dec 28 12:55:07 2007 for template7 by  doxygen 1.5.4