Open CASCADE Technology  6.9.0
Macros

Standard_DefineException.hxx File Reference

#include <Standard_Macro.hxx>
#include <Standard_DefineHandle.hxx>

Macros

#define DEFINE_STANDARD_EXCEPTION(C1, C2)
 Defines an exception class C1 that inherits an exception class C2. More...
 
#define IMPLEMENT_STANDARD_EXCEPTION(C1)
 Implements an exception class C1 declared with DEFINE_STANDARD_EXCEPTION macro. More...
 

Macro Definition Documentation

#define DEFINE_STANDARD_EXCEPTION (   C1,
  C2 
)
Value:
\
class C1 : public C2 { \
Standard_EXPORT virtual void Throw() const; \
public: \
C1() : C2() {} \
C1(const Standard_CString AString) : C2(AString) {} \
Standard_EXPORT static void Raise(const Standard_CString aMessage = ""); \
Standard_EXPORT static void Raise(Standard_SStream& aReason); \
Standard_EXPORT static Handle(C1) NewInstance(const Standard_CString aMessage = ""); \
\
};
#define Handle(ClassName)
Definition: Standard_Macro.hxx:23
const char * Standard_CString
Definition: Standard_TypeDef.hxx:71
#define DEFINE_STANDARD_RTTI(C1)
Definition: Standard_DefineHandle.hxx:93
std::stringstream Standard_SStream
Defines Standard_SStream as typedef to C++ string stream.
Definition: Standard_SStream.hxx:22

Defines an exception class C1 that inherits an exception class C2.

C2 must be Standard_Failure or its ancestor. The macro defines empty constructor, copy constructor and static methods Raise() and NewInstance(). Since Standard_Failure implements class manipulated by handle, DEFINE_STANDARD_RTTI macro is also added to enable RTTI.

When using DEFINE_STANDARD_EXCEPTION in your code make sure you also insert a macro DEFINE_STANDARD_HANDLE(C1,C2) before it.

See Also
IMPLEMENT_STANDARD_EXCEPTION.
#define IMPLEMENT_STANDARD_EXCEPTION (   C1)
Value:
\
void C1::Raise(Standard_SStream& aReason) \
{ \
Handle(C1) _E = new C1; \
_E->Reraise (aReason); \
} \
\
void C1::Raise(const Standard_CString AString) \
{ \
Handle(C1) _E = new C1; \
_E->Reraise(AString); \
} \
\
Handle(C1) C1::NewInstance(const Standard_CString aMessage) \
{ \
return new C1(aMessage); \
} \
void C1::Throw () const \
{ \
throw *this; \
}
#define Handle(ClassName)
Definition: Standard_Macro.hxx:23
const char * Standard_CString
Definition: Standard_TypeDef.hxx:71
std::stringstream Standard_SStream
Defines Standard_SStream as typedef to C++ string stream.
Definition: Standard_SStream.hxx:22

Implements an exception class C1 declared with DEFINE_STANDARD_EXCEPTION macro.

If you are using IMPLEMENT_STANDARD_EXCEPTION in your code make sure you also call IMPLEMENT_STANDARD_HANDLE(C1,C2) and IMPLEMENT_STANDARD_RTTIEXT(C1,C2).