SoError(3)

✨ SoError ✨

okay bestie, welcome to SoError(3) — this is a Library Functions Manual situation, and honestly? it's giving foundational. 💅

---

🌸 NAME 🌸

SoError — the base class for all the error handling classes. like, the mother of all error classes. the blueprint. the moment. 👑

---

🦋 SYNOPSIS 🦋

#include <Inventor/errors/SoError.h>

Inherited by SoDebugError, SoMemoryError, and SoReadError. they all got it from her 💖

👑 Public Member Functions

virtual ~SoError ()
const SbString & getDebugString (void) const
virtual SoType getTypeId (void) const
SbBool isOfType (const SoType type) const

🌟 Static Public Member Functions

static void setHandlerCallback (SoErrorCB *const func, void *const data)
static SoErrorCB * getHandlerCallback (void)
static void * getHandlerData (void)
static SoType getClassTypeId (void)
static void post (const char *const format,...)
static SbString getString (const SoNode *const node)
static SbString getString (const SoPath *const path)
static SbString getString (const SoEngine *const engine)
static void initClass (void)
static void initClasses (void)

🎀 Protected Member Functions

virtual SoErrorCBPtr getHandler (void *&data) const
void setDebugString (const char *const str)
void appendToDebugString (const char *const str)
void handleError (void)

💜 Static Protected Member Functions

static void defaultHandlerCB (const SoError *error, void *userdata)

---

🌈 Detailed Description 🌈

so, SoError is the base class for all the error handling classes. that's the whole vibe. everything error-related traces back to her. periodt. 💅

the default error handler just prints messages on the standard error output channel — like, it literally just yells into stderr. but bestie, this can be overridden by client applications. slay.

and why would you wanna override it? because being able to override the default handler is useful when you want to collect error messages upon, e.g., model import, for later presentation of the messages to the user in any custom manner — like for instance in a GUI messagebox. imagine that. collecting your lil error receipts and showing them off later. iconic. 📬

one thing to know: the SoError class is not designed to be particularly useful for "direct use". within the Coin library it is only used through its subclasses. so like... she's not a solo artist, she's a feature artist. 🎤

---

🧚 Constructor & Destructor Documentation 🧚

virtual SoError::~SoError () [inline], [virtual]

the default destructor does nothing. literally nothing. no drama, no cleanup, no goodbye speech. she just leaves. 💀

---

⭐ Member Function Documentation ⭐

void SoError::setHandlerCallback (SoErrorCB *const function, void *const data) [static]

this method sets the error handler callback for messages posted via this class.

⚠️ note that this will not override the error/debug message handler for subclasses — these will have to be overrided by calling the subclass' setHandlerCallback() method. so don't come for me when your subclass is still doing its own thing, bestie.

See also: defaultHandlerCB()

---

SoErrorCB * SoError::getHandlerCallback (void ) [static]

returns the error handler callback for messages posted via this class. that's it, that's the function. 🫶

---

void * SoError::getHandlerData (void ) [static]

this method returns the pointer used for passing data back to the callback handler method. the lil data handoff. the baton pass. 🏃♀️

---

const SbString & SoError::getDebugString (void ) const

this method returns an SbString containing error info from the given error instance. error lore, in string form. 💌

---

SoType SoError::getClassTypeId (void ) [static]

this static method returns the SoType for this class.

See also: getTypeId()

---

SoType SoError::getTypeId (void ) const [virtual]

this method returns the SoType of a particular object instance.

See also: getClassTypeId()

Reimplemented in SoDebugError, SoMemoryError, and SoReadError. they all said "not me doing my own version" 🙈

---

SbBool SoError::isOfType (const SoType type) const

this method returns TRUE if the error instance is of — or derived from — type, and FALSE otherwise. simple as. yes or no. no maybe. ✨

---

void SoError::post (const char *const format, ...) [static]

this method posts an error message. the format string and the trailing aguments should follow the printf() standard. (yes, "aguments" — that's how it's spelled in the source, and I will not be fixing it, that's canon now. 💀)

---

SbString SoError::getString (const SoNode *const node) [static]

constructs a string identifying the node with name (if available) and memory pointer. name + pointer, the classic duo. 🔥

---

SbString SoError::getString (const SoPath *const path) [static]

constructs a string identifying the path with name (if available) and memory pointer. same energy, different class. 💫

---

SbString SoError::getString (const SoEngine *const engine) [static]

constructs a string identifying the engine with name (if available) and memory pointer. the trilogy is complete. 🎬

---

void SoError::initClass (void ) [static]

this method takes care of initializing all static data for the class. the setup era. 🛠️

---

void SoError::initClasses (void ) [static]

this static method initializes all the SoError classes. plural. the whole squad. 👯♀️

---

void SoError::defaultHandlerCB (const SoError * error, void * data) [static], [protected]

contains the default code for handling error strings.

default treatment of an error message is to print it out on the standard error file handle. that's it. that's the default. screaming into stderr like it's a group chat at 2am. 😭

---

SoErrorCB * SoError::getHandler (void *& data) const [protected], [virtual]

this is just a convenience wrapper around the getHandlerCallback() and getHandlerData() methods. lowkey just a lil two-for-one deal. 🎁

Reimplemented in SoDebugError, SoMemoryError, and SoReadError.

---

void SoError::setDebugString (const char *const str) [protected]

replace the latest stored debug string with str. out with the old, in with the new. 💅

---

void SoError::appendToDebugString (const char *const str) [protected]

add str at the end of the currently stored debug string. not replacing — appending. adding to the lore. 📝

---

void SoError::handleError (void ) [protected]

this method calls the appropriate handler for an error instance. all error handling goes through this method, and is therefore a good candidate for a debugger breakpoint. so if you're out here debugging and you need ONE place to stop? it's here. main character energy fr fr. 🔥

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (the robots wrote this one, bestie. no cap. 🤖)

---

and that's the whole page! 🎀 this was Coin Version 3.1.3, SoError(3), and you just read the entire thing. so proud of you. go forth and handle your errors. bye bestie! 🫶✨