Open Inventor Reference
SoDebugError Class Reference

Debug error handling. More...

#include <Inventor/errors/SoDebugError.h>

Inheritance diagram for SoDebugError:
SoError

Public Types

enum  Severity { ERROR , WARNING , INFO }
 

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 SbStringgetDebugString () const
 Returns debug string containing full error information from instance.
 
virtual SoType getTypeId () const
 Returns type identifier for error instance.
 
bool isOfType (SoType type) const
 Returns TRUE if instance is of given type or is derived from it.
 

Static Public Member Functions

static void setHandlerCallback (SoErrorCB *cb, void *data)
 Sets/returns handler callback for SoDebugError class.
 
static SoErrorCBgetHandlerCallback ()
 Sets/returns handler callback for SoDebugError class.
 
static void * getHandlerData ()
 Sets/returns handler callback 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 void initClass ()
 Initializes SoDebugError class.
 
- Static Public Member Functions inherited from SoError
static void setHandlerCallback (SoErrorCB *cb, void *data)
 Sets/returns handler callback for SoError class.
 
static SoErrorCBgetHandlerCallback ()
 Sets/returns handler callback for SoError class.
 
static void * getHandlerData ()
 Sets/returns handler callback for SoError class.
 
static SoType getClassTypeId ()
 Returns type identifier for SoError class.
 
static void post (const char *formatString ...)
 Posts an error.
 
static SbString getString (const SoNode *node)
 These are convenience functions that return a printable string representing the given object.
 
static SbString getString (const SoPath *path)
 
static SbString getString (const SoEngine *engine)
 
static void initClass ()
 Initializes SoError class.
 
static void initClasses ()
 Initialize ALL Inventor error classes.
 

Protected Member Functions

virtual SoErrorCBgetHandler (void *&data) const
 Returns handler callback (and data) to use for a given instance.
 
virtual ~SoDebugError ()
 
- Protected Member Functions inherited from SoError
virtual SoErrorCBgetHandler (void *&data) const
 Returns handler callback (and data) to use for a given instance.
 
void setDebugString (const char *string)
 Sets/appends to the debug string.
 
void appendToDebugString (const char *string)
 
void handleError ()
 Calls appropriate handler for an error instance.
 
virtual ~SoError ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoError
static void defaultHandlerCB (const SoError *error, void *data)
 The default error handler callback - it just prints to stderr.
 

Detailed Description

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

See Also
SoMemoryError, SoReadError

Definition at line 88 of file SoDebugError.h.

Member Enumeration Documentation

◆ Severity

Enumerator
ERROR 

Error.

WARNING 

Just a warning.

INFO 

No error, just information.

Definition at line 91 of file SoDebugError.h.

Constructor & Destructor Documentation

◆ ~SoDebugError()

virtual SoDebugError::~SoDebugError ( )
inlineprotectedvirtual

Definition at line 135 of file SoDebugError.h.

Member Function Documentation

◆ getClassTypeId()

static SoType SoDebugError::getClassTypeId ( )
inlinestatic

Definition at line 106 of file SoDebugError.h.

◆ getHandler()

virtual SoErrorCB * SoDebugError::getHandler ( void *&  data) const
protectedvirtual

Reimplemented from SoError.

◆ getHandlerCallback()

static SoErrorCB * SoDebugError::getHandlerCallback ( )
inlinestatic

Definition at line 101 of file SoDebugError.h.

◆ getHandlerData()

static void * SoDebugError::getHandlerData ( )
inlinestatic

Definition at line 103 of file SoDebugError.h.

◆ getSeverity()

SoDebugError::Severity SoDebugError::getSeverity ( ) const
inline

Definition at line 112 of file SoDebugError.h.

◆ getTypeId()

virtual SoType SoDebugError::getTypeId ( ) const
virtual

Reimplemented from SoError.

◆ initClass()

static void SoDebugError::initClass ( )
static

◆ post()

◆ postInfo()

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

◆ postWarning()

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

◆ setHandlerCallback()

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

Definition at line 98 of file SoDebugError.h.


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