Class to handle errors and exceptions in a simple, consistent stream-based manner. More...

Inheritance diagram for error:

Collaboration diagram for error:

Public Member Functions
	error (const string &title)
	Construct from title string. More...

	error (const dictionary &errDict)
	Construct from dictionary. More...

	error (const error &err)
	Copy construct. More...

virtual	~error () noexcept
	Destructor. More...

string	message () const
	The accumulated error message. More...

void	clear () const
	Clear any messages. More...

const string &	functionName () const noexcept
	The currently defined function name for output messages. More...

const string &	sourceFileName () const noexcept
	The currently defined source-file name for output messages. More...

label	sourceFileLineNumber () const noexcept
	The currently defined source-file line number for output messages. More...

bool	throwing () const noexcept
	Return the current exception throwing state (on or off) More...

bool	throwing (const bool on) noexcept
	Specify exception throwing state (on or off) More...

OSstream &	stream ()
	Return OSstream for output operations. More...

	operator OSstream & ()
	Implicit cast to OSstream for << operations. More...

OSstream &	operator() ()
	Explicit convert to OSstream for << operations. More...

OSstream &	operator() (const string &functionName)
	Define basic print message. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber=0)
	Define basic print message. More...

OSstream &	operator() (const string &functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Define basic print message. More...

	operator dictionary () const
	Extract a dictionary representation of the error information. More...

void	exit (const int errNo=1)
	Exit : can be called for any error to exit program. More...

void	abort ()
	Abort : used to stop code for fatal errors. More...

virtual void	write (Ostream &os, const bool withTitle=true) const
	Print error message. More...

bool	throwExceptions (const bool on=true) noexcept
	Specify exception throwing state (default is on) More...

bool	dontThrowExceptions () noexcept
	Deactivate exception throwing. More...

Public Member Functions inherited from messageStream
	messageStream (const string &title, const errorSeverity severity, const int maxErrors=0)
	Construct from components. More...

	messageStream (const dictionary &dict)
	Construct as Fatal from dictionary, extracting the 'title'. More...

const string &	title () const noexcept
	The title of this error type. More...

int	maxErrors () const noexcept
	The maximum number of errors before program termination. More...

int	maxErrors (int nErrors) noexcept
	Set the maximum number of errors before program termination. More...

OSstream &	stream (OSstream *alternative=nullptr)
	Return OSstream for output operations. Use the `alternative` stream for serial-only output if it is a valid pointer. More...

OSstream &	masterStream (const label communicator)
	Return OSstream for output operations on the master process only, Snull on other processes. More...

std::ostream &	stdStream ()
	Return std::ostream for output operations. More...

	operator OSstream & ()
	Implicit cast to OSstream for << operations. More...

OSstream &	operator() ()
	Explicitly convert to OSstream for << operations. More...

OSstream &	operator() (const string &functionName)
	Report 'From function-name'. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber=0)
	Report 'From function-name, source file, line number' Print basic message. More...

OSstream &	operator() (const string &functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
	Report 'From function-name, source file, line number'. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Report 'From function-name, source file, line number' as well as io-file name and location. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Report 'From function-name, source file, line number' as well as io-file name and location. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Report 'From function-name, source file, line number' as well as io-file name and location. More...

Static Public Member Functions
static bool	master (const label communicator=-1)
	Like Pstream::master but with a Pstream::parRun guard in case Pstream has not yet been initialised. More...

static bool	warnAboutAge (const int version) noexcept
	Test if an age warning should be emitted. More...

static bool	warnAboutAge (const char *what, const int version)
	Emit warning on stderr about something being old. More...

static void	safePrintStack (std::ostream &os)
	Helper function to print a stack, used when OpenFOAM IO not yet initialised. More...

static void	printStack (Ostream &os)
	Helper function to print a stack. More...

static bool	useAbort ()
	True if FOAM_ABORT is on. More...

Protected Member Functions
void	simpleExit (const int errNo, const bool isAbort)
	Exit or abort, without throwing or job control handling. More...

Protected Attributes
string	functionName_

string	sourceFileName_

label	sourceFileLineNumber_

bool	throwing_

std::unique_ptr< OStringStream >	messageStreamPtr_

Protected Attributes inherited from messageStream
string	title_

errorSeverity	severity_

int	maxErrors_

int	errorCount_

Additional Inherited Members
Public Types inherited from messageStream
enum	errorSeverity { INFO = 1, INFO_STDERR, WARNING, SERIOUS, FATAL }
	Message type, error severity flags. More...

Static Public Attributes inherited from messageStream
static int	level
	The output level (verbosity) of messages. More...

static int	redirect
	The output redirection of messages. More...

Detailed Description

Class to handle errors and exceptions in a simple, consistent stream-based manner.

The error class is globally instantiated with a title string. Errors, messages and other data are piped to the messageStream class in the standard manner. Manipulators are supplied for exit and abort that may terminate the program or throw an exception depending on whether the exception handling has been switched on (off by default).

Usage: error << "message1" << "message2" << FoamDataType << exit(errNo);
error << "message1" << "message2" << FoamDataType << abort();

Source files

See also: Foam::errorManip Foam::errorManipArg

Definition at line 69 of file error.H.

Constructor & Destructor Documentation

◆ error() [1/3]

error ( const string & title )

explicit

Construct from title string.

Definition at line 103 of file error.C.

◆ error() [2/3]

error ( const dictionary & errDict )

explicit

Construct from dictionary.

Definition at line 115 of file error.C.

◆ error() [3/3]

error ( const error & err )

Copy construct.

Definition at line 127 of file error.C.

◆ ~error()

~error ( )

virtualnoexcept

Destructor.

Definition at line 141 of file error.C.

Member Function Documentation

◆ simpleExit()

void simpleExit	(	const int	errNo,
		const bool	isAbort
	)

protected

Exit or abort, without throwing or job control handling.

Definition at line 249 of file error.C.

References Foam::abort(), UPstream::abort(), Foam::endl(), Foam::exit(), UPstream::exit(), Foam::nl, UPstream::parRun(), Foam::Perr, error::printStack(), and error::useAbort().

Here is the call graph for this function:

◆ master()

bool master ( const label communicator = -1 )

static

Like Pstream::master but with a Pstream::parRun guard in case Pstream has not yet been initialised.

Parameters

communicator is the numbered MPI communicator. By default it uses UPstream::worldComm

Definition at line 37 of file error.C.

References UPstream::master(), and UPstream::parRun().

Referenced by Foam::expandLeadingTilde(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ warnAboutAge() [1/2]

bool warnAboutAge ( const int version )

staticnoexcept

Test if an age warning should be emitted.

Parameters

version is the old version (YYMM) for determining the age in months compared to the current OpenFOAM version as conveyed by the foamVersion::api value.

Definition at line 51 of file error.C.

References Foam::foamVersion::api, and Foam::foamVersion::version.

Referenced by Foam::expandLeadingTilde(), and timeControl::read().

Here is the caller graph for this function:

◆ warnAboutAge() [2/2]

bool warnAboutAge	(	const char *	what,
		const int	version
	)

static

Emit warning on stderr about something being old.

Parameters

what	description for the warning
version	is the old version (YYMM) for determining the age in months compared to the current OpenFOAM version as conveyed by the `foamVersion::api` value.

Definition at line 58 of file error.C.

References Foam::foamVersion::api, Foam::endl(), and Foam::foamVersion::version.

Here is the call graph for this function:

◆ message()

Foam::string message ( ) const

The accumulated error message.

Definition at line 315 of file error.C.

Referenced by motionSmootherAlgo::checkMesh().

Here is the caller graph for this function:

◆ clear()

void clear ( ) const

Clear any messages.

Definition at line 321 of file error.C.

Referenced by motionSmootherAlgo::checkMesh().

Here is the caller graph for this function:

◆ functionName()

const string& functionName ( ) const

inlinenoexcept

The currently defined function name for output messages.

Definition at line 174 of file error.H.

References error::functionName_.

◆ sourceFileName()

const string& sourceFileName ( ) const

inlinenoexcept

The currently defined source-file name for output messages.

Definition at line 182 of file error.H.

References error::sourceFileName_.

◆ sourceFileLineNumber()

label sourceFileLineNumber ( ) const

inlinenoexcept

The currently defined source-file line number for output messages.

Definition at line 190 of file error.H.

References error::sourceFileLineNumber_.

◆ throwing() [1/2]

bool throwing ( ) const

inlinenoexcept

Return the current exception throwing state (on or off)

Definition at line 198 of file error.H.

References error::throwing_.

Referenced by functionObjectList::end(), functionObjectList::execute(), if(), IOobjectList::IOobjectList(), functionObjectList::read(), and error::throwExceptions().

Here is the caller graph for this function:

◆ throwing() [2/2]

bool throwing ( const bool on )

inlinenoexcept

Specify exception throwing state (on or off)

Returns: the previous throwing state

Definition at line 208 of file error.H.

References error::throwing_.

◆ stream()

Foam::OSstream & stream ( )

Return OSstream for output operations.

Definition at line 300 of file error.C.

References Foam::abort(), Foam::endl(), Foam::nl, and Foam::Perr.

Referenced by error::operator OSstream &(), error::operator()(), and Time::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator OSstream &()

operator OSstream & ( )

inline

Implicit cast to OSstream for << operations.

Definition at line 226 of file error.H.

References error::stream().

Here is the call graph for this function:

◆ operator()() [1/4]

OSstream& operator() ( )

inline

Explicit convert to OSstream for << operations.

Definition at line 234 of file error.H.

References error::stream().

Here is the call graph for this function:

◆ operator()() [2/4]

Foam::OSstream & operator() ( const string & functionName )

Define basic print message.

Returns: OSstream for further operations

Definition at line 148 of file error.C.

◆ operator()() [3/4]

Foam::OSstream & operator()	(	const char *	functionName,
		const char *	sourceFileName,
		const int	sourceFileLineNumber = `0`
	)

Define basic print message.

Returns: OSstream for further operations

Definition at line 161 of file error.C.

◆ operator()() [4/4]

Foam::OSstream & operator()	(	const string &	functionName,
		const char *	sourceFileName,
		const int	sourceFileLineNumber = `0`
	)

Define basic print message.

Returns: OSstream for further operations

Definition at line 187 of file error.C.

◆ operator dictionary()

operator dictionary ( ) const

Extract a dictionary representation of the error information.

◆ safePrintStack()

void safePrintStack ( std::ostream & os )

static

Helper function to print a stack, used when OpenFOAM IO not yet initialised.

Definition at line 25 of file dummyPrintStack.C.

◆ printStack()

void printStack ( Ostream & os )

static

Helper function to print a stack.

Definition at line 29 of file dummyPrintStack.C.

Referenced by Foam::exitNow(), messageStream::masterStream(), Foam::reduce(), and error::simpleExit().

Here is the caller graph for this function:

◆ useAbort()

bool useAbort ( )

static

True if FOAM_ABORT is on.

Definition at line 94 of file error.C.

References Switch::find(), and Foam::getEnv().

Referenced by Foam::exitNow(), and error::simpleExit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exit()

void exit ( const int errNo = 1 )

Exit : can be called for any error to exit program.

Redirects to abort() when FOAM_ABORT is on.

Definition at line 327 of file error.C.

Referenced by Foam::exit(), and if().

Here is the caller graph for this function:

◆ abort()

void abort ( )

Abort : used to stop code for fatal errors.

Prints stack before exiting.

Definition at line 333 of file error.C.

Referenced by Foam::abort().

Here is the caller graph for this function:

◆ write()

void write	(	Ostream &	os,
		const bool	withTitle = `true`
	)		const

virtual

Print error message.

Reimplemented in IOerror.

Definition at line 339 of file error.C.

References Foam::foamVersion::api, IOstream::bad(), messageStream::level, Foam::nl, os(), Foam::foamVersion::patch, and Foam::foamVersion::patched().

Referenced by functionObjectList::end(), functionObjectList::execute(), Foam::operator<<(), argList::parse(), and functionObjectList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ throwExceptions()

bool throwExceptions ( const bool on = true )

inlinenoexcept

Specify exception throwing state (default is on)

Returns: the previous throwing state

Definition at line 326 of file error.H.

References error::throwing().

Referenced by error::dontThrowExceptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dontThrowExceptions()

bool dontThrowExceptions ( )

inlinenoexcept

Deactivate exception throwing.

Returns: the previous throwing state

Definition at line 336 of file error.H.

References error::throwExceptions().

Here is the call graph for this function:

Member Data Documentation

◆ functionName_

string functionName_

protected

Definition at line 86 of file error.H.

Referenced by error::functionName().

◆ sourceFileName_

string sourceFileName_

protected

Definition at line 87 of file error.H.

Referenced by error::sourceFileName().

◆ sourceFileLineNumber_

label sourceFileLineNumber_

protected

Definition at line 88 of file error.H.

Referenced by error::sourceFileLineNumber().

◆ throwing_

bool throwing_

protected

Definition at line 89 of file error.H.

Referenced by error::throwing().

◆ messageStreamPtr_

std::unique_ptr<OStringStream> messageStreamPtr_

protected

Definition at line 90 of file error.H.

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

src/OpenFOAM/db/error/error.H
src/OpenFOAM/db/error/error.C
src/OSspecific/POSIX/printStack/dummyPrintStack.C
src/OSspecific/POSIX/printStack/printStack.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ error() [1/3]

◆ error() [2/3]

◆ error() [3/3]

◆ ~error()

Member Function Documentation

◆ simpleExit()

◆ master()

◆ warnAboutAge() [1/2]

◆ warnAboutAge() [2/2]

◆ message()

◆ clear()

◆ functionName()

◆ sourceFileName()

◆ sourceFileLineNumber()

◆ throwing() [1/2]

◆ throwing() [2/2]

◆ stream()

◆ operator OSstream &()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator dictionary()

◆ safePrintStack()

◆ printStack()

◆ useAbort()

◆ exit()

◆ abort()

◆ write()

◆ throwExceptions()

◆ dontThrowExceptions()

Member Data Documentation

◆ functionName_

◆ sourceFileName_

◆ sourceFileLineNumber_

◆ throwing_

◆ messageStreamPtr_