SoReadError(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoReadError 💖

okay bestie, welcome to the SoReadError page — it's a manual page for the Coin library, section 3 (that's library functions, iykyk). buckle up, it's giving "error class that handles model imports" and honestly? kinda iconic.

✨ NAME ✨

SoReadError — the SoReadError class is used during model import operations. that's it, that's the vibe. 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/errors/SoReadError.h>

Inherits SoError. yes queen, it's a whole family tree situation. 👑

💅 Public Member Functions

virtual SoType getTypeId (void) const — gives you back the type id, fr fr

🫶 Public Member Functions inherited from SoError

virtual ~SoError () — the destructor, she cleans up after herself
const SbString & getDebugString (void) const — hands you the debug string
SbBool isOfType (const SoType type) const — asks "are you that type, bestie?"

🌈 Static Public Member Functions

static void setHandlerCallback (SoErrorCB *const function, void *const data) — sets up your handler callback
static SoErrorCB * getHandlerCallback (void) — gets the handler callback back
static void * getHandlerData (void) — gets the handler data
static SoType getClassTypeId (void) — the class-level type id
static void post (const SoInput *const input, const char *const format,...) — posts an error/warning message
static void initClass (void) — sets the class up

✨ Static Public Member Functions inherited from SoError

static void setHandlerCallback (SoErrorCB *const func, void *const data) — sets the handler callback
static SoErrorCB * getHandlerCallback (void) — gets the handler callback
static void * getHandlerData (void) — gets the handler data
static SoType getClassTypeId (void) — the class type id
static void post (const char *const format,...) — posts a message
static SbString getString (const SoNode *const node) — string from a node
static SbString getString (const SoPath *const path) — string from a path
static SbString getString (const SoEngine *const engine) — string from an engine
static void initClass (void) — init that class
static void initClasses (void) — init all the classes, plural era

🎀 Protected Member Functions

virtual SoErrorCBPtr getHandler (void *&data) const — the handler getter, protected tho

🧚 Protected Member Functions inherited from SoError

void setDebugString (const char *const str) — sets the debug string
void appendToDebugString (const char *const str) — appends to the debug string
void handleError (void) — handles the error

💜 Additional Inherited Members

⭐ Static Protected Member Functions inherited from SoError

static void defaultHandlerCB (const SoError *error, void *userdata) — the default handler callback, the OG fallback

🦋 Detailed Description 🦋

the SoReadError class is used during model import operations. no cap.

during model file import, this class will be used to output any error or warning messages. she's literally the messenger. 💌

depending on your application, setting up your own error handler callbacks for SoReadError might be a good idea. lowkey a great idea actually, do it for yourself. 🫶

💖 Member Function Documentation 💖

🌸 `SoType SoReadError::getTypeId (void ) const` [virtual]

this method returns the SoType of a particular object instance. it's giving "who am I, really?" energy. 🪞

See also

getClassTypeId()

Reimplemented from SoError.

🌈 `void SoReadError::post (const SoInput const in, const char const format, ...)` [static]

method used from import code to post error or warning messages for model files which are not 100% compliant to the format specification. yes bestie, we're calling out the messy files. 📢

the messages will be wrapped within information on line number, file offset etc. so you get the receipts. 🧾✨

🎀 `SoErrorCB * SoReadError::getHandler (void *& data) const` [protected], [virtual]

this is just a convenience wrapper around the getHandlerCallback() and getHandlerData() methods. she's a shortcut, and honestly? we love a shortcut. 💅