Classes | Namespaces | Macros | Variables
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.

Classes

class  messageStream
 Handle output messages in a simple, consistent stream-based manner. More...
 

Namespaces

 Foam
 

Macros

#define FUNCTION_NAME   __func__
 
#define SeriousErrorIn(functionName)   ::Foam::SeriousError((functionName), __FILE__, __LINE__)
 
#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)
 
#define SeriousIOErrorIn(functionName, ios)   ::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)
 
#define SeriousIOErrorInFunction(ios)   SeriousIOErrorIn(FUNCTION_NAME, ios)
 
#define WarningIn(functionName)   ::Foam::Warning((functionName), __FILE__, __LINE__)
 
#define WarningInFunction   WarningIn(FUNCTION_NAME)
 
#define IOWarningIn(functionName, ios)   ::Foam::Warning((functionName), __FILE__, __LINE__, (ios))
 
#define IOWarningInFunction(ios)   IOWarningIn(FUNCTION_NAME, ios)
 
#define InfoIn(functionName)   ::Foam::Info((functionName), __FILE__, __LINE__)
 
#define InfoInFunction   InfoIn(FUNCTION_NAME)
 
#define PoutIn(functionName)   ::Foam::Pout << (functionName) << ':'
 
#define PoutInFunction   PoutIn(FUNCTION_NAME)
 
#define DetailInfo   if (::Foam::infoDetailLevel > 0) Info
 
#define Log   if (log) Info
 
#define IOInfoIn(functionName, ios)   ::Foam::Info((functionName), __FILE__, __LINE__, (ios))
 
#define IOInfoInFunction(ios)   IOInfoIn(FUNCTION_NAME, ios)
 
#define DebugInfo   if (debug) Info
 
#define DebugInFunction   if (debug) InfoInFunction
 
#define DebugPout   if (debug) Pout
 
#define DebugPoutInFunction   if (debug) PoutInFunction
 
#define DebugVar(var)
 

Variables

int infoDetailLevel
 
messageStream Info
 
messageStream InfoErr
 
messageStream Warning
 
messageStream SeriousError
 

Detailed Description

Original source file messageStream.H

Definition in file messageStream.H.

Macro Definition Documentation

◆ FUNCTION_NAME

#define FUNCTION_NAME   __func__

Definition at line 302 of file messageStream.H.

◆ SeriousErrorIn

#define SeriousErrorIn (   functionName)    ::Foam::SeriousError((functionName), __FILE__, __LINE__)

Definition at line 311 of file messageStream.H.

◆ SeriousErrorInFunction

#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)

Definition at line 319 of file messageStream.H.

◆ SeriousIOErrorIn

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

Definition at line 328 of file messageStream.H.

◆ SeriousIOErrorInFunction

#define SeriousIOErrorInFunction (   ios)    SeriousIOErrorIn(FUNCTION_NAME, ios)

Definition at line 337 of file messageStream.H.

◆ WarningIn

#define WarningIn (   functionName)    ::Foam::Warning((functionName), __FILE__, __LINE__)

Definition at line 345 of file messageStream.H.

◆ WarningInFunction

#define WarningInFunction   WarningIn(FUNCTION_NAME)

Definition at line 353 of file messageStream.H.

◆ IOWarningIn

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

Definition at line 362 of file messageStream.H.

◆ IOWarningInFunction

#define IOWarningInFunction (   ios)    IOWarningIn(FUNCTION_NAME, ios)

Definition at line 371 of file messageStream.H.

◆ InfoIn

#define InfoIn (   functionName)    ::Foam::Info((functionName), __FILE__, __LINE__)

Definition at line 379 of file messageStream.H.

◆ InfoInFunction

#define InfoInFunction   InfoIn(FUNCTION_NAME)

Definition at line 387 of file messageStream.H.

◆ PoutIn

#define PoutIn (   functionName)    ::Foam::Pout << (functionName) << ':'

Definition at line 392 of file messageStream.H.

◆ PoutInFunction

#define PoutInFunction   PoutIn(FUNCTION_NAME)

Definition at line 398 of file messageStream.H.

◆ DetailInfo

#define DetailInfo   if (::Foam::infoDetailLevel > 0) Info

Definition at line 403 of file messageStream.H.

◆ Log

#define Log   if (log) Info

Definition at line 409 of file messageStream.H.

◆ IOInfoIn

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

Definition at line 419 of file messageStream.H.

◆ IOInfoInFunction

#define IOInfoInFunction (   ios)    IOInfoIn(FUNCTION_NAME, ios)

Definition at line 428 of file messageStream.H.

◆ DebugInfo

#define DebugInfo   if (debug) Info

Definition at line 436 of file messageStream.H.

◆ DebugInFunction

#define DebugInFunction   if (debug) InfoInFunction

Definition at line 445 of file messageStream.H.

◆ DebugPout

#define DebugPout   if (debug) Pout

Definition at line 453 of file messageStream.H.

◆ DebugPoutInFunction

#define DebugPoutInFunction   if (debug) PoutInFunction

Definition at line 462 of file messageStream.H.

◆ DebugVar

#define DebugVar (   var)
Value:
{ \
::Foam::string oldPrefix(::Foam::Pout.prefix()); \
::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] "; \
::Foam::Pout.prefix() = oldPrefix + #var " "; \
::Foam::Pout.prefix() = oldPrefix; \
}

Definition at line 470 of file messageStream.H.

Foam::endl
Ostream & endl(Ostream &os)
Definition: Ostream.H:381
Foam::string
A class for handling character strings derived from std::string.
Definition: string.H:72
Foam::Pout
prefixOSstream Pout
Foam::prefixOSstream::prefix
const string & prefix() const noexcept
Definition: prefixOSstream.H:97