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

const string &	sourceFileName () const

label	sourceFileLineNumber () const

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

bool	throwExceptions (bool doThrow)
	Activate/deactivate exception throwing. More...

bool	throwExceptions ()
	Activate exception throwing. More...

bool	dontThrowExceptions ()
	Deactivate exception throwing. 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...

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

	operator OSstream & ()
	Convert to OSstream. More...

	operator dictionary () const
	Create and return a dictionary representation of the error. 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...

void	write (Ostream &os, const bool includeTitle=true) const
	Print error message. 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
	The title of this error type. More...

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

int &	maxErrors ()

OSstream &	masterStream (const label communicator)
	Convert to OSstream. More...

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

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

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

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
	Print basic message. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const IOstream &)
	Print basic message. More...

OSstream &	operator() (const char functionName, const char sourceFileName, const int sourceFileLineNumber, const dictionary &)
	Print basic message. More...

	operator OSstream & ()
	Convert to OSstream for << operations. More...

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

Static Public Member Functions
static void	warnAboutAge (const char *what, const int version)
	Emit warning on stderr about something being old. More...

static void	safePrintStack (std::ostream &os)

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

static bool	useAbort ()
	True if FOAM_ABORT is on. 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, WARNING, SERIOUS, FATAL, INFO_STDERR = INFO \| 0x10 }
	Message type, or 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 70 of file error.H.

Constructor & Destructor Documentation

◆ error() [1/3]

error ( const string & title )

explicit

Construct from title string.

Definition at line 83 of file error.C.

◆ error() [2/3]

error ( const dictionary & errDict )

explicit

Construct from dictionary.

Definition at line 95 of file error.C.

◆ error() [3/3]

error ( const error & err )

Copy construct.

Definition at line 107 of file error.C.

◆ ~error()

~error ( )

virtualnoexcept

Destructor.

Definition at line 121 of file error.C.

Member Function Documentation

◆ warnAboutAge()

void 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 41 of file error.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ message()

Foam::string message ( ) const

The accumulated error message.

Definition at line 277 of file error.C.

Referenced by snappyLayerDriver::addLayers(), and motionSmootherAlgo::checkMesh().

Here is the caller graph for this function:

◆ clear()

void clear ( ) const

Clear any messages.

Definition at line 283 of file error.C.

Referenced by motionSmootherAlgo::checkMesh().

Here is the caller graph for this function:

◆ functionName()

const string& functionName ( ) const

inline

Definition at line 128 of file error.H.

References error::functionName_.

◆ sourceFileName()

const string& sourceFileName ( ) const

inline

Definition at line 133 of file error.H.

References error::sourceFileName_.

◆ sourceFileLineNumber()

label sourceFileLineNumber ( ) const

inline

Definition at line 138 of file error.H.

References error::sourceFileLineNumber_.

◆ throwing()

bool throwing ( ) const

inline

Return the current exception throwing (on or off)

Definition at line 144 of file error.H.

References error::throwing_.

◆ throwExceptions() [1/2]

bool throwExceptions ( bool doThrow )

inline

Activate/deactivate exception throwing.

Returns: the previous throwing state

Definition at line 151 of file error.H.

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

Here is the caller graph for this function:

◆ throwExceptions() [2/2]

bool throwExceptions ( )

inline

Activate exception throwing.

Returns: the previous throwing state

Definition at line 160 of file error.H.

◆ dontThrowExceptions()

bool dontThrowExceptions ( )

inline

Deactivate exception throwing.

Returns: the previous throwing state

Definition at line 167 of file error.H.

◆ operator()() [1/4]

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

Define basic print message.

Returns: OSstream for further info.

Definition at line 128 of file error.C.

◆ operator()() [2/4]

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

Define basic print message.

Returns: OSstream for further info.

Definition at line 141 of file error.C.

◆ operator()() [3/4]

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

Define basic print message.

Returns: OSstream for further info.

Definition at line 156 of file error.C.

◆ operator()() [4/4]

OSstream& operator() ( )

inline

Explicit convert to OSstream for << operations.

Definition at line 198 of file error.H.

Referenced by IOerror::operator()().

Here is the caller graph for this function:

◆ operator OSstream &()

operator OSstream & ( )

Convert to OSstream.

◆ operator dictionary()

operator dictionary ( ) const

Create and return a dictionary representation of the error.

◆ safePrintStack()

void safePrintStack ( std::ostream & os )

static

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

Definition at line 32 of file dummyPrintStack.C.

◆ printStack()

void printStack ( Ostream & os )

static

Helper function to print a stack.

Definition at line 36 of file dummyPrintStack.C.

Referenced by UPstream::allToAll(), Foam::exitNow(), messageStream::masterStream(), and Foam::reduce().

Here is the caller graph for this function:

◆ useAbort()

bool useAbort ( )

static

True if FOAM_ABORT is on.

Definition at line 74 of file error.C.

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

Referenced by Foam::exitNow().

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 289 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 295 of file error.C.

Referenced by Foam::abort().

Here is the caller graph for this function:

◆ write()

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

Print error message.

Definition at line 301 of file error.C.

References Foam::foamVersion::api, IOstream::bad(), messageStream::level, Foam::nl, 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:

Member Data Documentation

◆ functionName_

string functionName_

protected

Definition at line 85 of file error.H.

Referenced by error::functionName().

◆ sourceFileName_

string sourceFileName_

protected

Definition at line 86 of file error.H.

Referenced by error::sourceFileName().

◆ sourceFileLineNumber_

label sourceFileLineNumber_

protected

Definition at line 87 of file error.H.

Referenced by error::sourceFileLineNumber().

◆ throwing_

bool throwing_

protected

Definition at line 88 of file error.H.

Referenced by error::throwing().

◆ messageStreamPtr_

std::unique_ptr<OStringStream> messageStreamPtr_

protected

Definition at line 89 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/MSwindows/printStack/dummyPrintStack.C
src/OSspecific/POSIX/printStack/printStack.C

Public Member Functions

Static Public 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

◆ warnAboutAge()

◆ message()

◆ clear()

◆ functionName()

◆ sourceFileName()

◆ sourceFileLineNumber()

◆ throwing()

◆ throwExceptions() [1/2]

◆ throwExceptions() [2/2]

◆ dontThrowExceptions()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator OSstream &()

◆ operator dictionary()

◆ safePrintStack()

◆ printStack()

◆ useAbort()

◆ exit()

◆ abort()

◆ write()

Member Data Documentation

◆ functionName_

◆ sourceFileName_

◆ sourceFileLineNumber_

◆ throwing_

◆ messageStreamPtr_