messageStream.H File Reference

Include dependency graph for messageStream.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	messageStream
	Class to handle messaging in a simple, consistent stream-based manner. More...

Namespaces
	Foam
	Namespace for OpenFOAM.

Macros
#define	FUNCTION_NAME   __func__
#define	SeriousErrorIn(functionName)   ::Foam::SeriousError((functionName), __FILE__, __LINE__)
	Report an error message using Foam::SeriousError. More...
#define	SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)
	Report an error message using Foam::SeriousError. More...
#define	SeriousIOErrorIn(functionName, ios)   ::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)
	Report an IO error message using Foam::SeriousError. More...
#define	SeriousIOErrorInFunction(ios)   SeriousIOErrorIn(FUNCTION_NAME, ios)
	Report an IO error message using Foam::SeriousError. More...
#define	WarningIn(functionName)   ::Foam::Warning((functionName), __FILE__, __LINE__)
	Report a warning using Foam::Warning. More...
#define	WarningInFunction   WarningIn(FUNCTION_NAME)
	Report a warning using Foam::Warning. More...
#define	IOWarningIn(functionName, ios)   ::Foam::Warning((functionName), __FILE__, __LINE__, (ios))
	Report an IO warning using Foam::Warning. More...
#define	IOWarningInFunction(ios)   IOWarningIn(FUNCTION_NAME, ios)
	Report an IO warning using Foam::Warning. More...
#define	InfoIn(functionName)   ::Foam::Info((functionName), __FILE__, __LINE__)
	Report a information message using Foam::Info. More...
#define	InfoInFunction   InfoIn(FUNCTION_NAME)
	Report a information message using Foam::Info. More...
#define	IOInfoIn(functionName, ios)   ::Foam::Info((functionName), __FILE__, __LINE__, (ios))
	Report an IO information message using Foam::Info. More...
#define	IOInfoInFunction(ios)   IOInfoIn(FUNCTION_NAME, ios)
	Report an IO information message using Foam::Info. More...
#define	Debug(var)
	Report a variable name and value. More...

Variables
messageStream	SeriousError
messageStream	Warning
messageStream	Info

Detailed Description

Original source file messageStream.H

Definition in file messageStream.H.

Macro Definition Documentation

FUNCTION_NAME

#define FUNCTION_NAME   __func__

Definition at line 226 of file messageStream.H.

SeriousErrorIn

#define SeriousErrorIn

(

functionName

)

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

Report an error message using Foam::SeriousError.

for functionName in file __FILE__ at line __LINE__

Definition at line 232 of file messageStream.H.

SeriousErrorInFunction

#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)

Report an error message using Foam::SeriousError.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 237 of file messageStream.H.

SeriousIOErrorIn

#define SeriousIOErrorIn	(		functionName,
			ios
	)		::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)

Report an IO error message using Foam::SeriousError.

for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 243 of file messageStream.H.

SeriousIOErrorInFunction

#define SeriousIOErrorInFunction

(

ios

)

SeriousIOErrorIn(FUNCTION_NAME, ios)

Report an IO error message using Foam::SeriousError.

for FUNCTION_NAME in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 249 of file messageStream.H.

WarningIn

#define WarningIn

(

functionName

)

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

Report a warning using Foam::Warning.

for functionName in file __FILE__ at line __LINE__

Definition at line 254 of file messageStream.H.

WarningInFunction

#define WarningInFunction   WarningIn(FUNCTION_NAME)

Report a warning using Foam::Warning.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 259 of file messageStream.H.

IOWarningIn

#define IOWarningIn	(		functionName,
			ios
	)		::Foam::Warning((functionName), __FILE__, __LINE__, (ios))

Report an IO warning using Foam::Warning.

for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 265 of file messageStream.H.

IOWarningInFunction

#define IOWarningInFunction

(

ios

)

IOWarningIn(FUNCTION_NAME, ios)

Report an IO warning using Foam::Warning.

for FUNCTION_NAME in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 271 of file messageStream.H.

InfoIn

#define InfoIn

(

functionName

)

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

Report a information message using Foam::Info.

for functionName in file __FILE__ at line __LINE__

Definition at line 276 of file messageStream.H.

InfoInFunction

#define InfoInFunction   InfoIn(FUNCTION_NAME)

Report a information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 281 of file messageStream.H.

IOInfoIn

#define IOInfoIn	(		functionName,
			ios
	)		::Foam::Info((functionName), __FILE__, __LINE__, (ios))

Report an IO information message using Foam::Info.

for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 287 of file messageStream.H.

IOInfoInFunction

#define IOInfoInFunction

(

ios

)

IOInfoIn(FUNCTION_NAME, ios)

Report an IO information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 293 of file messageStream.H.

Debug

#define Debug

(

var

)

Value:

    ::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] "                   \
    << #var " " << var << ::Foam::endl

Report a variable name and value.

using Foam::Pout in file __FILE__ at line __LINE__

Definition at line 298 of file messageStream.H.