SoErrorStack Class Reference
[Errors]

Stack debugging handler. More...

#include <Inventor/errors/SoErrorStack.h>

Inheritance diagram for SoErrorStack:

List of all members.

Classes
struct	StackFrame
	This struture contains the description of a stack frame. More...
Public Member Functions
virtual SoType	getTypeId () const
std::vector < SoErrorStack::StackFrame >	getStackFrames () const
SbString	getStack () const
Static Public Member Functions
static void	setHandlerCallback (SoErrorCB *cb, void *data)
static SoErrorCB *	getHandlerCallback ()
static void *	getHandlerData ()
static SoType	getClassTypeId ()
static void	post ()

---

Detailed Description

Stack debugging handler.

SoErrorStack is used to obtain and/or report the program callstack.

The post() method gets the actual callstack and calls a custom callback, if one is defined, else it dumps the callstack using SoDebugError.

It is also possible to allow SoStackError to automaticaly report the callstack, when a signal is reported by the system, by setting OIV_DEBUG_STACKERROR to 1.

SEE ALSO

SoReadError

---

Member Function Documentation

static SoType SoErrorStack::getClassTypeId

(

)

[static]

Returns the type identifier for the SoErrorStack class.

Reimplemented from SoError.

static SoErrorCB* SoErrorStack::getHandlerCallback

(

)

[static]

Returns the handler callback for the SoErrorStack class.

Returns:

The SoErrorCB specified by the setHandlerCallback function.

Reimplemented from SoError.

static void* SoErrorStack::getHandlerData

(

)

[static]

Returns the handler callback data for the SoErrorStack class.

Returns:

The void* pointer specified by the setHandlerCallback function.

Reimplemented from SoError.

SbString SoErrorStack::getStack

(

)

const

This function returns a decoded version of the getStackFrames() function.

Returns:

A string which contains a human readable version of the stack.

std::vector< SoErrorStack::StackFrame > SoErrorStack::getStackFrames

(

)

const

Returns the stack frames of the current callback stack.

This function is useful to get the stack frames when the custom callback is called.

Returns:

The list of frames in the actual callstack.

virtual SoType SoErrorStack::getTypeId

(

)

const [virtual]

Returns the type identifier for an instance of SoErrorStack.

Reimplemented from SoError.

static void SoErrorStack::post

(

)

[static]

Posts the current callstack to the application callback or to SoDebugError if the custom callback was not specified.

static void SoErrorStack::setHandlerCallback	(	SoErrorCB *	cb,
		void *	data
	)			[static]

Sets the handler callback for the SoErrorStack class.

Parameters:

	cb	The error callback.
	data	Custom data forwarded to the callback, can be NULL.

Reimplemented from SoError.

---

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

• Inventor/errors/SoErrorStack.h