Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
ExceptionBase Class Reference

#include <exceptions.h>

Inheritance diagram for ExceptionBase:
[legend]

Public Member Functions

 ExceptionBase ()
 
 ExceptionBase (const ExceptionBase &exc)
 
virtual ~ExceptionBase () throw ()
 
void set_fields (const char *file, const int line, const char *function, const char *cond, const char *exc_name)
 
virtual const char * what () const throw ()
 
const char * get_exc_name () const
 
void print_exc_data (std::ostream &out) const
 
virtual void print_info (std::ostream &out) const
 
void print_stack_trace (std::ostream &out) const
 

Protected Attributes

const char * file
 
unsigned int line
 
const char * function
 
const char * cond
 
const char * exc
 
char ** stacktrace
 
int n_stacktrace_frames
 

Private Member Functions

void generate_message () const
 

Private Attributes

std::string what_str
 

Detailed Description

This class is the base class for all exception classes. Do not use its methods and variables directly since the interface and mechanism may be subject to change. Rather create new exception classes using the DeclException macro family.

See the Exceptions and assertions module for more details on this class and what can be done with classes derived from it.

Author
Wolfgang Bangerth, 1997, 1998, Matthias Maier, 2013

Definition at line 46 of file exceptions.h.

Constructor & Destructor Documentation

ExceptionBase::ExceptionBase ( )

Default constructor.

ExceptionBase::ExceptionBase ( const ExceptionBase exc)

Copy constructor.

virtual ExceptionBase::~ExceptionBase ( )
throw (
)
virtual

Destructor.

Member Function Documentation

void ExceptionBase::set_fields ( const char *  file,
const int  line,
const char *  function,
const char *  cond,
const char *  exc_name 
)

Set the file name and line of where the exception appeared as well as the violated condition and the name of the exception as a char pointer. This function also populates the stacktrace.

virtual const char* ExceptionBase::what ( ) const
throw (
)
virtual

Override the standard function that returns the description of the error.

const char* ExceptionBase::get_exc_name ( ) const

Get exception name.

void ExceptionBase::print_exc_data ( std::ostream &  out) const

Print out the general part of the error information.

virtual void ExceptionBase::print_info ( std::ostream &  out) const
virtual

Print more specific information about the exception which occurred. Overload this function in your own exception classes.

Reimplemented in SolverControl::NoConvergence.

void ExceptionBase::print_stack_trace ( std::ostream &  out) const

Print a stacktrace, if one has been recorded previously, to the given stream.

void ExceptionBase::generate_message ( ) const
private

Internal function that generates the c_string. Called by what().

Member Data Documentation

const char* ExceptionBase::file
protected

Name of the file this exception happens in.

Definition at line 107 of file exceptions.h.

unsigned int ExceptionBase::line
protected

Line number in this file.

Definition at line 112 of file exceptions.h.

const char* ExceptionBase::function
protected

Name of the function, pretty printed.

Definition at line 117 of file exceptions.h.

const char* ExceptionBase::cond
protected

The violated condition, as a string.

Definition at line 122 of file exceptions.h.

const char* ExceptionBase::exc
protected

Name of the exception and call sequence.

Definition at line 127 of file exceptions.h.

char** ExceptionBase::stacktrace
mutableprotected

A backtrace to the position where the problem happened, if the system supports this.

Definition at line 133 of file exceptions.h.

int ExceptionBase::n_stacktrace_frames
protected

The number of stacktrace frames that are stored in the previous variable. Zero if the system does not support stack traces.

Definition at line 139 of file exceptions.h.

std::string ExceptionBase::what_str
mutableprivate

A pointer to the c_string that will be printed by what(). It is populated by generate_message()

Definition at line 158 of file exceptions.h.


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