.TH "SoMemoryError" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoMemoryError \- The \fBSoMemoryError\fP class is used to inform of problems with memory allocation\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoError\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoError\fP .in +1c .ti -1c .RI "virtual \fB~SoError\fP ()" .br .ti -1c .RI "const \fBSbString\fP & \fBgetDebugString\fP (void) const" .br .ti -1c .RI "SbBool \fBisOfType\fP (const \fBSoType\fP type) const" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static void \fBsetHandlerCallback\fP (SoErrorCB *const callback, void *const data)" .br .ti -1c .RI "static SoErrorCB * \fBgetHandlerCallback\fP (void)" .br .ti -1c .RI "static void * \fBgetHandlerData\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBpost\fP (const char *const whatWasAllocated)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoError\fP .in +1c .ti -1c .RI "static void \fBsetHandlerCallback\fP (SoErrorCB *const func, void *const data)" .br .ti -1c .RI "static SoErrorCB * \fBgetHandlerCallback\fP (void)" .br .ti -1c .RI "static void * \fBgetHandlerData\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBpost\fP (const char *const format,\&.\&.\&.)" .br .ti -1c .RI "static \fBSbString\fP \fBgetString\fP (const \fBSoNode\fP *const node)" .br .ti -1c .RI "static \fBSbString\fP \fBgetString\fP (const \fBSoPath\fP *const path)" .br .ti -1c .RI "static \fBSbString\fP \fBgetString\fP (const \fBSoEngine\fP *const engine)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual SoErrorCBPtr \fBgetHandler\fP (void *&data) const" .br .in -1c Protected Member Functions inherited from \fBSoError\fP .in +1c .ti -1c .RI "void \fBsetDebugString\fP (const char *const str)" .br .ti -1c .RI "void \fBappendToDebugString\fP (const char *const str)" .br .ti -1c .RI "void \fBhandleError\fP (void)" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoError\fP .in +1c .ti -1c .RI "static void \fBdefaultHandlerCB\fP (const \fBSoError\fP *error, void *userdata)" .br .in -1c .SH "Detailed Description" .PP The \fBSoMemoryError\fP class is used to inform of problems with memory allocation\&. Modern operating systems takes care of handling most out of memory conditions for you, but in certain situations it can be wise to do some manual checking and intervention\&. This class is provided as an aid to help out in these situations\&. .PP The basic design of the Coin library is to pass on the responsibility for handling failed attempts at memory allocation to the application programmer\&. If you want to detect and take care of these, you should compile Coin with the C++ exception throwing on and wrap your code within \fRtry{}\fP and \fRcatch{}\fP blocks\&. The most you can do if you get a failed allocation is typically to notify the user and then exit the application, though, and this is something most operating systems will do for you, so you probably need not consider this at all\&. .PP So, where does the \fBSoMemoryError\fP class come in handy? There are certain things which could happen within the library which are best taken care of by internally handling failed attempts at memory allocation\&. An example: the user tries to load a model file which contains a filename pointer to a huge bitmap file with a texture map\&. The end-user's system does not provide enough memory to load the file and prepare the texture image for rendering, though\&. This is a case where it is possible to just emit a warning and continue\&. The warning will then be passed through this class\&. .PP Note that \fBSoMemoryError\fP is probably not of much use to the application programmer\&. .SH "Member Function Documentation" .PP .SS "void SoMemoryError::setHandlerCallback (SoErrorCB *const function, void *const data)\fR [static]\fP" This method sets the error handler callback for messages posted via this class\&. .PP Note that this will not override the error/debug message handler for subclasses, these will have to be overridden by calling the subclass' \fBsetHandlerCallback()\fP method\&. .PP \fBSee also\fP .RS 4 \fBdefaultHandlerCB()\fP .RE .PP .SS "SoErrorCB * SoMemoryError::getHandlerCallback (void )\fR [static]\fP" Returns the error handler callback for messages posted via this class\&. .SS "void * SoMemoryError::getHandlerData (void )\fR [static]\fP" This method returns the pointer used for passing data back to the callback handler method\&. .SS "\fBSoType\fP SoMemoryError::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP for this class\&. .PP \fBSee also\fP .RS 4 \fBgetTypeId()\fP .RE .PP .SS "\fBSoType\fP SoMemoryError::getTypeId (void ) const\fR [virtual]\fP" This method returns the \fBSoType\fP of a particular object instance\&. .PP \fBSee also\fP .RS 4 \fBgetClassTypeId()\fP .RE .PP .PP Reimplemented from \fBSoError\fP\&. .SS "void SoMemoryError::post (const char *const whatWasAllocated)\fR [static]\fP" Posts a warning about a failed memory allocation\&. \fIwhatWasAllocated\fP should contain a description of what we tried to allocate\&. .SS "void SoMemoryError::initClass (void )\fR [static]\fP" This method takes care of initializing all static data for the class\&. .SS "SoErrorCB * SoMemoryError::getHandler (void *& data) const\fR [protected]\fP, \fR [virtual]\fP" This is just a convenience wrapper around the \fBgetHandlerCallback()\fP and \fBgetHandlerData()\fP methods\&. .PP Reimplemented from \fBSoError\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.