SoDebugError Class Reference

Debug error handling. More...

#include <Inventor/errors/SoDebugError.h>

Inheritance diagram for SoDebugError:

Public Types
enum	Severity {   SERROR =0 ,   ERROR =SERROR ,   WARNING =1 ,   INFO =2 }
	Error severity. More...
Public Types inherited from SoError
typedef void	SoErrorCB(const SoError *error, void *data)
	Error handling callbacks are of this type.

Public Member Functions
virtual SoType	getTypeId () const
	Returns type identifier for error instance.
SoDebugError::Severity	getSeverity () const
	Returns severity of error (for use by handlers).
Public Member Functions inherited from SoError
const SbString &	getDebugString () const
	Returns debug string containing full error information from instance.
virtual	~SoError ()
	Destructor.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static void	setHandlerCallback (SoErrorCB *cb, void *data)
	Sets handler callback for SoDebugError class.
static SoErrorCB *	getHandlerCallback ()
	Returns handler callback for SoDebugError class.
static void *	getHandlerData ()
	Returns handler data for SoDebugError class.
static SoType	getClassTypeId ()
	Returns type identifier for SoDebugError class.
static void	post (const char *methodName, const char *formatString ...)
	Posts an error.
static void	postWarning (const char *methodName, const char *formatString ...)
	Posts a warning.
static void	postInfo (const char *methodName, const char *formatString ...)
	Posts an informational (non-error) message.
Static Public Member Functions inherited from SoError
static void	setHandlerCallback (SoErrorCB *cb, void *data)
	Sets handler callback for SoError class.
static SoErrorCB *	getHandlerCallback ()
	Returns handler callback for SoError class.
static void *	getHandlerData ()
	Returns handler data for SoError class.
static SoType	getClassTypeId ()
	Returns type identifier for SoError class.
static SoPRINTF void	post (const char *formatString ...)
	Posts an error.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Debug error handling.

SoDebugError is used for all errors reported from Open Inventor library. These errors are typically programmer errors, such as passing a null reference or an out-of-range index. The post() method takes the name of the Open Inventor method that detected the error, to aid the programmer in debugging.

See SoError for full discussion of error handling in Open Inventor.

SEE ALSO

SoMemoryError, SoReadError, SoGLError

Definition at line 93 of file SoDebugError.h.

Member Enumeration Documentation

Severity

enum SoDebugError::Severity

Error severity.

Enumerator
SERROR	Error.
ERROR
WARNING	Just a warning.
INFO	No error, just information.

Definition at line 97 of file SoDebugError.h.

Member Function Documentation

getClassTypeId()

static SoType SoDebugError::getClassTypeId ( )

static

Returns type identifier for SoDebugError class.

getHandlerCallback()

static SoErrorCB * SoDebugError::getHandlerCallback ( )

static

Returns handler callback for SoDebugError class.

getHandlerData()

static void * SoDebugError::getHandlerData ( )

static

Returns handler data for SoDebugError class.

getSeverity()

SoDebugError::Severity SoDebugError::getSeverity ( ) const

inline

Returns severity of error (for use by handlers).

Definition at line 146 of file SoDebugError.h.

getTypeId()

virtual SoType SoDebugError::getTypeId ( ) const

virtual

Returns type identifier for error instance.

Reimplemented from SoError.

post()

static void SoDebugError::post ( const char *  methodName, const char *  formatString ...  )

static

Posts an error.

postInfo()

static void SoDebugError::postInfo ( const char *  methodName, const char *  formatString ...  )

static

Posts an informational (non-error) message.

postWarning()

static void SoDebugError::postWarning ( const char *  methodName, const char *  formatString ...  )

static

Posts a warning.

setHandlerCallback()

static void SoDebugError::setHandlerCallback ( SoErrorCB *  cb, void *  data  )

static

Sets handler callback for SoDebugError class.

---

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

• Inventor/errors/SoDebugError.h