Drag[en]gine Game Engine  1.0
deErrorTrace Class Reference

Error Trace. More...

#include <deErrorTrace.h>

Public Member Functions

Constructors and Destructors
 deErrorTrace ()
 
 ~deErrorTrace ()
 
Management
const char * GetError () const
 
void SetError (const char *error)
 
void Clear ()
 
Trace Point Management
bool HasPoints () const
 
bool IsEmpty () const
 
int GetPointCount () const
 
deErrorTracePointGetPoint (int index) const
 
void AddPoint (deErrorTracePoint *point)
 
void RemoveAllPoints ()
 
Convenience Functions
deErrorTracePointAddAndSetIfEmpty (const char *error, deLoadableModule *sourceModule, const char *sourceFunc, int sourceLine)
 
deErrorTracePointAddPoint (deLoadableModule *sourceModule, const char *sourceFunc, int sourceLine)
 
void PrintTrace (deLogger &logger)
 

Detailed Description

Error Trace.

An Error Trace object contains a list of Error Trace Point objects. describing the path of an error that occured in the engine.

Author
Pl├╝ss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deErrorTrace()

deErrorTrace::deErrorTrace ( )

Creates a new error trace object.

◆ ~deErrorTrace()

deErrorTrace::~deErrorTrace ( )

Cleans up the error trace object.

Member Function Documentation

◆ AddAndSetIfEmpty()

deErrorTracePoint* deErrorTrace::AddAndSetIfEmpty ( const char *  error,
deLoadableModule sourceModule,
const char *  sourceFunc,
int  sourceLine 
)

Adds the given error to the trace and sets the error if there exists no trace point yet. Returns the new trace point if added or NULL otherwise.

Referenced by GetPointCount().

◆ AddPoint() [1/2]

void deErrorTrace::AddPoint ( deErrorTracePoint point)

Adds a new trace point.

Referenced by GetPointCount().

◆ AddPoint() [2/2]

deErrorTracePoint* deErrorTrace::AddPoint ( deLoadableModule sourceModule,
const char *  sourceFunc,
int  sourceLine 
)

Adds a new trace point with the given informations.

◆ Clear()

void deErrorTrace::Clear ( )

Clears the error trace.

Referenced by GetError().

◆ GetError()

const char* deErrorTrace::GetError ( ) const
inline

Retrieves the error.

References Clear(), and SetError().

◆ GetPoint()

deErrorTracePoint* deErrorTrace::GetPoint ( int  index) const

Retrieves the indexed trace point.

Referenced by GetPointCount().

◆ GetPointCount()

int deErrorTrace::GetPointCount ( ) const
inline

Retrieves the count of trace points.

References AddAndSetIfEmpty(), AddPoint(), GetPoint(), PrintTrace(), and RemoveAllPoints().

◆ HasPoints()

bool deErrorTrace::HasPoints ( ) const
inline

Determines if there exist trace points.

◆ IsEmpty()

bool deErrorTrace::IsEmpty ( ) const
inline

Determines if the trace is empty.

◆ PrintTrace()

void deErrorTrace::PrintTrace ( deLogger logger)

Prints the error trace out to the given logger. This is more of a temporary function and should not be used.

Referenced by GetPointCount().

◆ RemoveAllPoints()

void deErrorTrace::RemoveAllPoints ( )

Removes all trace points.

Referenced by GetPointCount().

◆ SetError()

void deErrorTrace::SetError ( const char *  error)

Sets the error.

Referenced by GetError().


The documentation for this class was generated from the following file: