MPQC  3.0.0-alpha
sc::AssertionFailed Class Reference

This is thrown when an assertion fails. More...

#include <util/misc/scexception.h>

Inheritance diagram for sc::AssertionFailed:
sc::SCException sc::Exception

Public Member Functions

 AssertionFailed (const char *assertion_text, const char *file, int line) MPQC__NOEXCEPT
 Create an AssertionFailed exception. More...
 
const char * assertion_text () const MPQC__NOEXCEPT
 
- Public Member Functions inherited from sc::SCException
 SCException (const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type="SCException") MPQC__NOEXCEPT
 Create an SCException. More...
 
 SCException (const SCException &) MPQC__NOEXCEPT
 
const char * what () const MPQC__NOEXCEPT
 overload of Exception::what()
 
const ClassDescclass_desc () const MPQC__NOEXCEPT
 Returns the class descriptor of the object which generated the exception. More...
 
const char * exception_type () const MPQC__NOEXCEPT
 Returns the classname of the exception. May return null.
 
std::ostream & elaborate ()
 Returns a stream where additional information about the exception can be written. More...
 
- Public Member Functions inherited from sc::Exception
 Exception (const char *description=0, const char *file=0, int line=0) MPQC__NOEXCEPT
 Create an Exception. More...
 
 Exception (const Exception &) MPQC__NOEXCEPT
 
const char * description () const MPQC__NOEXCEPT
 Reimplementation of std::exception::what(). More...
 
const char * file () const MPQC__NOEXCEPT
 Returns the name of the file in which the exception was created. More...
 
int line () const MPQC__NOEXCEPT
 Returns the line number where the exception was created. More...
 

Detailed Description

This is thrown when an assertion fails.

It is used by the MPQC_ASSERT macro. Don't use it without this macro.

Constructor & Destructor Documentation

◆ AssertionFailed()

sc::AssertionFailed::AssertionFailed ( const char *  assertion_text,
const char *  file,
int  line 
)

Create an AssertionFailed exception.

Parameters
theactual code in the assertion
filethe file name where the problem occured.
linethe line number where the exception occured.

It is suggested that the special macros FILE and LINE be given as the file and line arguments, respectively.


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

Generated at Sun Jan 26 2020 23:24:03 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.8.16.