SoReadError(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoReadError(3) 🎀

okay so bestie, welcome to the SoReadError(3) page from the Library Functions Manual — yes, that one. this is the class that carries the whole model-import error situation on her back, and she does it flawlessly. 💅

✨ NAME ✨

SoReadError — the SoReadError class is used during model import operations.

🌸 SYNOPSIS 🌸

#include <Inventor/errors/SoReadError.h>

Inherits SoError.

💜 Public Member Functions

virtual SoType getTypeId (void) const

🦋 Public Member Functions inherited from SoError

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

💖 Static Public Member Functions

static void setHandlerCallback (SoErrorCB *const function, void *const data)
static SoErrorCB * getHandlerCallback (void)
static void * getHandlerData (void)
static SoType getClassTypeId (void)
static void post (const SoInput *const in, const char *const format,...)
static void initClass (void)

🌈 Static Public Member Functions inherited from SoError

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

🍓 Protected Member Functions inherited from SoError

void setDebugString (const char *const str)
void appendToDebugString (const char *const str)
void handleError (void)

⭐ Additional Inherited Members

💫 Static Protected Member Functions inherited from SoError

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

🦋 Detailed Description 🦋

The SoReadError class is used during model import operations. that's her whole thing, she's booked and busy ✨

During model file import, this class will be used to output any error or warning messages.

Depending on your application, setting up your own error handler callbacks for SoReadError might be a good idea. lowkey recommended, ngl — do it.

💅 Member Function Documentation 💅

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

This method returns the SoType of a particular object instance.

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. the messy files, the chaotic ones, the ones that didn't read the assignment 😭

The messages will be wrapped within information on line number, file offset etc. so you actually know where the drama happened. 🕵️‍♀️

References SoError::appendToDebugString(), SoError::defaultHandlerCB(), SoInput::getLocationString(), SbString::getString(), SoError::handleError(), SoError::setDebugString(), and SbString::vsprintf().

Referenced by SoInput::openFile(), SoInput::pushFile(), SoBase::read(), SoDB::read(), SoDB::read(), SoField::read(), SoFieldData::read(), SoInput::read(), SoInput::read(), SoInput::read(), SoGroup::readChildren(), SoField::readConnection(), SoFieldData::readFieldDescriptions(), SoBumpMap::readInstance(), SoImage::readInstance(), SoTexture2::readInstance(), SoTextureCubeMap::readInstance(), SoVRMLImageTexture::readInstance(), SoFile::readNamedFile(), and SoBase::readRoute().

not me listing SoDB::read() twice and SoInput::read() three times — bestie that's exactly how the original lists them, so they stay. no cap. 🫶

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

This is just a convenience wrapper around the getHandlerCallback() and getHandlerData() methods. she's simple, she's cute, she's a wrapper 💖