Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Protected Member Functions
Standard_Failure Class Reference

Forms the root of the entire exception hierarchy.

#include <Standard_Failure.hxx>

Inheritance diagram for Standard_Failure:
Inheritance graph
[legend]

Public Member Functions

 Standard_Failure ()
 Creates a status object of type "Failure".

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

Standard_Failureoperator= (const Standard_Failure &f)
void Destroy ()
 ~Standard_Failure ()
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&, <br> Handle(Standard_Failure)&)"
is implemented. (This operator uses the method Print)


void operator<< (Standard_OStream &s) const
Standard_CString GetMessageString () const
 Returns error message

void SetMessageString (const Standard_CString aMessage)
 Sets error message

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

void Jump () const
 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.

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.

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.

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.

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.

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()


Constructor & Destructor Documentation


Member Function Documentation

static Handle_Standard_Failure Standard_Failure::Caught ( ) [static]
static Handle_Standard_Failure Standard_Failure::NewInstance ( const Standard_CString  aMessage) [static]
void Standard_Failure::operator<< ( Standard_OStream s) const [inline]
Standard_Failure& Standard_Failure::operator= ( const Standard_Failure f)
static void Standard_Failure::Raise ( const Standard_CString  aMessage = "") [static]
static void Standard_Failure::Raise ( const Standard_SStream aReason) [static]
virtual void Standard_Failure::Throw ( ) const [protected, virtual]

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