Error Trace. More...

#include <deErrorTrace.h>

Public Member Functions
Constructors and Destructors
	deErrorTrace ()
	Creates a new error trace object.
	~deErrorTrace ()
	Cleans up the error trace object.
Management
const char *	GetError () const
	Retrieves the error.
void	SetError (const char *error)
	Sets the error.
void	Clear ()
	Clears the error trace.
Trace Point Management
bool	HasPoints () const
	Determines if there exist trace points.
bool	IsEmpty () const
	Determines if the trace is empty.
int	GetPointCount () const
	Retrieves the count of trace points.
deErrorTracePoint *	GetPoint (int index) const
	Retrieves the indexed trace point.
void	AddPoint (deErrorTracePoint *point)
	Adds a new trace point.
void	RemoveAllPoints ()
	Removes all trace points.
Convenience Functions
deErrorTracePoint *	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.
deErrorTracePoint *	AddPoint (deLoadableModule sourceModule, const char sourceFunc, int sourceLine)
	Adds a new trace point with the given informations.
void	PrintTrace (deLogger &logger)
	Prints the error trace out to the given 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.

Constructor & Destructor Documentation

deErrorTrace::deErrorTrace ( )

Creates a new error trace object.

deErrorTrace::~deErrorTrace ( )

Cleans up the error trace object.

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.

void deErrorTrace::AddPoint ( deErrorTracePoint * point )

Adds a new trace point.

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

Adds a new trace point with the given informations.

void deErrorTrace::Clear ( )

Clears the error trace.

const char* deErrorTrace::GetError ( ) const [inline]

Retrieves the error.

deErrorTracePoint* deErrorTrace::GetPoint ( int index ) const

Retrieves the indexed trace point.

int deErrorTrace::GetPointCount ( ) const [inline]

Retrieves the count of trace points.

bool deErrorTrace::HasPoints ( ) const [inline]

Determines if there exist trace points.

bool deErrorTrace::IsEmpty ( ) const [inline]

Determines if the trace is empty.

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.

void deErrorTrace::RemoveAllPoints ( )

Removes all trace points.

void deErrorTrace::SetError ( const char * error )

Sets the error.

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