Forms the root of the entire exception hierarchy. More...

#include <Standard_Failure.hxx>

Inheritance diagram for Standard_Failure:

Public Member Functions
	Standard_Failure ()
	Creates a status object of type "Failure". More...

	Standard_Failure (const Standard_Failure &f)
	Copy constructor. More...

	Standard_Failure (const Standard_CString aString)
	Creates a status object of type "Failure". More...

Standard_Failure &	operator= (const Standard_Failure &f)
	Assignment operator. More...

	~Standard_Failure ()
	Destructor. More...

void	Print (Standard_OStream &s) const
	Prints on the stream <s> the exception name followed by the error message. Level: Advanced Warning: The operator "OStream& operator<< (Standard_OStream&, Handle(Standard_Failure)&)" is implemented. (This operator uses the method Print) More...

virtual Standard_CString	GetMessageString () const
	Returns error message. More...

virtual void	SetMessageString (const Standard_CString aMessage)
	Sets error message. More...

void	Reraise ()

void	Reraise (const Standard_CString aMessage)

void	Reraise (const Standard_SStream &aReason)
	Reraises a caught exception and changes its error message. More...

void	Jump ()
	Used to throw CASCADE exception from C signal handler. On platforms that do not allow throwing C++ exceptions from this handler (e.g. Linux), uses longjump to get to the current active signal handler, and only then is converted to C++ exception. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	Delete () const
	Memory deallocator for transient classes. More...

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object. More...

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type. More...

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

void	IncrementRefCounter () const
	Increments the reference counter of this object. More...

Standard_Integer	DecrementRefCounter () const
	Decrements the reference counter of this object; returns the decremented value. More...

Static Public Member Functions
static void	Raise (const Standard_CString aMessage="")
	Raises an exception of type "Failure" and associates an error message to it. The message can be printed in an exception handler. More...

static void	Raise (const Standard_SStream &aReason)
	Raises an exception of type "Failure" and associates an error message to it. The message can be constructed at run-time. More...

static Handle< Standard_Failure >	NewInstance (const Standard_CString aMessage)
	Used to construct an instance of the exception object as a handle. Shall be used to protect against possible construction of exception object in C stack – that is dangerous since some of methods require that object was allocated dynamically. More...

static Handle< Standard_Failure >	Caught ()
	Returns the last caught exception. Needed when exceptions are emulated by C longjumps, in other cases is also provided for compatibility. More...

Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Protected Member Functions
virtual void	Throw () const
	Used only if standard C++ exceptions are used. Throws exception of the same type as this by C++ throw, and stores current object as last thrown exception, to be accessible by method Caught() More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...

Detailed Description

Forms the root of the entire exception hierarchy.

Constructor & Destructor Documentation

◆ Standard_Failure() [1/3]

Standard_Failure::Standard_Failure ( )

Creates a status object of type "Failure".

◆ Standard_Failure() [2/3]

Standard_Failure::Standard_Failure ( const Standard_Failure & f )

Copy constructor.

◆ Standard_Failure() [3/3]

Standard_Failure::Standard_Failure ( const Standard_CString aString )

Creates a status object of type "Failure".

◆ ~Standard_Failure()

Standard_Failure::~Standard_Failure ( )

Destructor.

Member Function Documentation

◆ Caught()

static Handle< Standard_Failure > Standard_Failure::Caught ( )

static

Returns the last caught exception. Needed when exceptions are emulated by C longjumps, in other cases is also provided for compatibility.

Deprecated:: ("This method is deprecated (not thread-safe), use standard C++ mechanism instead")

◆ GetMessageString()

virtual Standard_CString Standard_Failure::GetMessageString ( ) const

virtual

Returns error message.

◆ Jump()

void Standard_Failure::Jump ( )

Used to throw CASCADE exception from C signal handler. On platforms that do not allow throwing C++ exceptions from this handler (e.g. Linux), uses longjump to get to the current active signal handler, and only then is converted to C++ exception.

◆ NewInstance()

static Handle< Standard_Failure > Standard_Failure::NewInstance ( const Standard_CString aMessage )

static

Used to construct an instance of the exception object as a handle. Shall be used to protect against possible construction of exception object in C stack – that is dangerous since some of methods require that object was allocated dynamically.

◆ operator=()

Standard_Failure& Standard_Failure::operator= ( const Standard_Failure & f )

Assignment operator.

◆ Print()

void Standard_Failure::Print ( Standard_OStream & s ) const

Prints on the stream <s> the exception name followed by the error message. Level: Advanced Warning: The operator "OStream& operator<< (Standard_OStream&, Handle(Standard_Failure)&)" is implemented. (This operator uses the method Print)

◆ Raise() [1/2]

static void Standard_Failure::Raise ( const Standard_CString aMessage = "" )

static

Raises an exception of type "Failure" and associates an error message to it. The message can be printed in an exception handler.

◆ Raise() [2/2]

static void Standard_Failure::Raise ( const Standard_SStream & aReason )

static

Raises an exception of type "Failure" and associates an error message to it. The message can be constructed at run-time.

◆ Reraise() [1/3]

void Standard_Failure::Reraise ( )

◆ Reraise() [2/3]

void Standard_Failure::Reraise ( const Standard_CString aMessage )

◆ Reraise() [3/3]

void Standard_Failure::Reraise ( const Standard_SStream & aReason )

Reraises a caught exception and changes its error message.

◆ SetMessageString()

virtual void Standard_Failure::SetMessageString ( const Standard_CString aMessage )

virtual

Sets error message.

◆ Throw()

virtual void Standard_Failure::Throw ( ) const

protectedvirtual

Used only if standard C++ exceptions are used. Throws exception of the same type as this by C++ throw, and stores current object as last thrown exception, to be accessible by method Caught()

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

Standard_Failure.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Standard_Failure() [1/3]

◆ Standard_Failure() [2/3]

◆ Standard_Failure() [3/3]

◆ ~Standard_Failure()

Member Function Documentation

◆ Caught()

◆ GetMessageString()

◆ Jump()

◆ NewInstance()

◆ operator=()

◆ Print()

◆ Raise() [1/2]

◆ Raise() [2/2]

◆ Reraise() [1/3]

◆ Reraise() [2/3]

◆ Reraise() [3/3]

◆ SetMessageString()

◆ Throw()