Standard_OutOfMemory Class Reference

Standard_OutOfMemory exception is defined explicitly and not by macro DEFINE_STANDARD_EXCEPTION, to avoid necessity of dynamic memory allocations during throwing and stack unwinding: More...

#include <Standard_OutOfMemory.hxx>

Inheritance diagram for Standard_OutOfMemory:

Public Member Functions
	Standard_OutOfMemory (const Standard_CString theMessage=0)
	Constructor is kept public for backward compatibility.
Standard_CString	GetMessageString () const override
	Returns error message.
void	SetMessageString (const Standard_CString aMessage) override
	Sets error message.

Static Public Member Functions
static void	Raise (const Standard_CString theMessage="")
	Raises exception with specified message string.
static void	Raise (Standard_SStream &theMessage)
	Raises exception with specified message string.
static Handle< Standard_OutOfMemory >	NewInstance (Standard_CString theMessage="")
	Returns global instance of exception.
static Handle< Standard_OutOfMemory >	NewInstance (Standard_CString theMessage, Standard_CString theStackTrace)
	Returns global instance of exception.

Protected Attributes
char	myBuffer [1024]

Detailed Description

Standard_OutOfMemory exception is defined explicitly and not by macro DEFINE_STANDARD_EXCEPTION, to avoid necessity of dynamic memory allocations during throwing and stack unwinding:

• method NewInstance() returns static instance (singleton)
• method Raise() raises copy of that singleton, resetting its message string
• message string is stored as field, not allocated dynamically (storable message length is limited by buffer size)

The reason is that in out-of-memory condition any memory allocation can fail, thus use of operator new for allocation of new exception instance is dangerous (can cause recursion until stack overflow, see #24836).

Constructor & Destructor Documentation

Standard_OutOfMemory()

Standard_OutOfMemory::Standard_OutOfMemory

(

const Standard_CString

theMessage = 0

)

Constructor is kept public for backward compatibility.

Member Function Documentation

GetMessageString()

Standard_CString Standard_OutOfMemory::GetMessageString ( ) const

override

Returns error message.

NewInstance() [1/2]

static Handle< Standard_OutOfMemory > Standard_OutOfMemory::NewInstance ( Standard_CString  theMessage, Standard_CString  theStackTrace  )

static

Returns global instance of exception.

NewInstance() [2/2]

static Handle< Standard_OutOfMemory > Standard_OutOfMemory::NewInstance ( Standard_CString  theMessage = "" )

static

Returns global instance of exception.

Raise() [1/2]

static void Standard_OutOfMemory::Raise ( const Standard_CString  theMessage = "" )

static

Raises exception with specified message string.

Raise() [2/2]

static void Standard_OutOfMemory::Raise ( Standard_SStream &  theMessage )

static

Raises exception with specified message string.

SetMessageString()

void Standard_OutOfMemory::SetMessageString ( const Standard_CString  aMessage )

override

Sets error message.

Field Documentation

myBuffer

char Standard_OutOfMemory::myBuffer[1024]

protected

---

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

• Standard_OutOfMemory.hxx