sc::ToleranceExceeded Class Reference

This is thrown when when some tolerance is exceeded. More...

#include <util/misc/scexception.h>

Inheritance diagram for sc::ToleranceExceeded:

Public Member Functions
	ToleranceExceeded (const char *description=0, const char *file=0, int line=0, double tol=0, double val=0, const ClassDesc *class_desc=0, const char *exception_type="ToleranceExceeded") MPQC__NOEXCEPT
	Create a ToleranceExceeded exception. More...
	ToleranceExceeded (const ToleranceExceeded &) MPQC__NOEXCEPT
double	tolerance () MPQC__NOEXCEPT
	Return the required tolerance.
double	value () MPQC__NOEXCEPT
	Return the value which was obtained.
Public Member Functions inherited from sc::AlgorithmException
	AlgorithmException (const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type="AlgorithmException") MPQC__NOEXCEPT
	Create an AlgorithmException. More...
	AlgorithmException (const AlgorithmException &) 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 ClassDesc *	class_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 when some tolerance is exceeded.

Constructor & Destructor Documentation

ToleranceExceeded()

sc::ToleranceExceeded::ToleranceExceeded	(	const char *	description = 0,
		const char *	file = 0,
		int	line = 0,
		double	tol = 0,
		double	val = 0,
		const ClassDesc *	class_desc = 0,
		const char *	exception_type = "ToleranceExceeded"
	)

Create a ToleranceExceeded exception.

Parameters

description	a description of the problem.
file	the file name where the problem occured.
line	the line number where the exception occured.
tol	the required tolerance.
val	the value which was obtained.
class_desc	the ClassDesc for the object causing the exception.
exception_type	the classname of the SCException specialization. The default is "ToleranceExceeded".

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:

• src/lib/util/misc/scexception.h