error.H File Reference

Include dependency graph for error.H:

Go to the source code of this file.

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

Namespaces
	Foam

Macros
#define	FatalErrorIn(functionName)   ::Foam::FatalError((functionName), __FILE__, __LINE__)
#define	FatalErrorInFunction   FatalErrorIn(FUNCTION_NAME)
#define	FatalErrorInLookup(lookupTag, lookupName, lookupTable)
#define	FatalIOErrorIn(functionName, ios)   ::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))
#define	FatalIOErrorInFunction(ios)   FatalIOErrorIn(FUNCTION_NAME, ios)
#define	FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
#define	SafeFatalIOErrorIn(functionName, ios, msg)
#define	SafeFatalIOErrorInFunction(ios, msg)   SafeFatalIOErrorIn(FUNCTION_NAME, ios, msg)
#define	notImplemented(functionName)
#define	NotImplemented   notImplemented(FUNCTION_NAME)

Functions
Ostream &	operator<< (Ostream &os, const error &err)
Ostream &	operator<< (Ostream &os, const IOerror &err)

Variables
error	FatalError
IOerror	FatalIOError

Detailed Description

Original source file error.H

Definition in file error.H.

Macro Definition Documentation

FatalErrorIn

#define FatalErrorIn

(

functionName

)

::Foam::FatalError((functionName), __FILE__, __LINE__)

Definition at line 457 of file error.H.

FatalErrorInFunction

#define FatalErrorInFunction   FatalErrorIn(FUNCTION_NAME)

Definition at line 465 of file error.H.

FatalErrorInLookup

#define FatalErrorInLookup	(		lookupTag,
			lookupName,
			lookupTable
	)

Value:

    ::Foam::FatalError(FUNCTION_NAME, __FILE__, __LINE__)                      \
    << "Unknown " << (lookupTag) << " type " << (lookupName)                   \
    << "\n\nValid " << (lookupTag) << " types :\n"                             \
    << ((lookupTable).sortedToc()) << '\n'

Definition at line 472 of file error.H.

FatalIOErrorIn

#define FatalIOErrorIn	(		functionName,
			ios
	)		::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))

Definition at line 485 of file error.H.

FatalIOErrorInFunction

#define FatalIOErrorInFunction

(

ios

)

FatalIOErrorIn(FUNCTION_NAME, ios)

Definition at line 494 of file error.H.

FatalIOErrorInLookup

#define FatalIOErrorInLookup	(		ios,
			lookupTag,
			lookupName,
			lookupTable
	)

Value:

    ::Foam::FatalIOError(FUNCTION_NAME, __FILE__, __LINE__, (ios))             \
    << "Unknown " << (lookupTag) << " type " << (lookupName)                   \
    << "\n\nValid " << (lookupTag) << " types :\n"                             \
    << ((lookupTable).sortedToc()) << '\n'

Definition at line 502 of file error.H.

SafeFatalIOErrorIn

#define SafeFatalIOErrorIn	(		functionName,
			ios,
			msg
	)

Value:

    ::Foam::IOerror::SafeFatalIOError                                          \
    ((functionName), __FILE__, __LINE__, (ios), (msg))

Definition at line 516 of file error.H.

SafeFatalIOErrorInFunction

#define SafeFatalIOErrorInFunction	(		ios,
			msg
	)		SafeFatalIOErrorIn(FUNCTION_NAME, ios, msg)

Definition at line 527 of file error.H.

notImplemented

#define notImplemented

(

functionName

)

Value:

    FatalErrorIn(functionName)                                                 \
        << "Not implemented" << ::Foam::abort(FatalError);

Definition at line 540 of file error.H.

NotImplemented

#define NotImplemented   notImplemented(FUNCTION_NAME)

Definition at line 553 of file error.H.