OpenFOAM logo
Open Source CFD Toolkit

messageStream.H File Reference


Detailed Description

View messageStream.H
License
This file is part of OpenFOAM.

OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Class to handle messaging in a simple, consistent stream-based
manner.  The messageStream class is globaly instantiated with a title string
a given severity, which controls the program termination, and a number
of errors before termination.  Errors, messages and other data are piped
to the messageStream class in the standard manner.

Usage
messageStream << "message1" << "message2" << FoamDataType << endl;

Source files

Definition in file messageStream.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  messageStream

Defines

#define SeriousErrorIn(fn)   SeriousError(fn, __FILE__, __LINE__)
#define SeriousIOErrorIn(fn, ios)   SeriousError(fn, __FILE__, __LINE__, ios)
#define WarningIn(fn)   Warning(fn, __FILE__, __LINE__)
#define IOWarningIn(fn, ios)   Warning(fn, __FILE__, __LINE__, ios)
#define InfoIn(fn)   Info(fn, __FILE__, __LINE__)
#define IOInfoIn(fn, ios)   Info(fn, __FILE__, __LINE__, ios)

Variables

messageStream SeriousError
messageStream Warning
messageStream Info


Define Documentation

#define InfoIn fn   )     Info(fn, __FILE__, __LINE__)
 

Definition at line 224 of file messageStream.H.

#define IOInfoIn fn,
ios   )     Info(fn, __FILE__, __LINE__, ios)
 

Definition at line 225 of file messageStream.H.

#define IOWarningIn fn,
ios   )     Warning(fn, __FILE__, __LINE__, ios)
 

Definition at line 222 of file messageStream.H.

#define SeriousErrorIn fn   )     SeriousError(fn, __FILE__, __LINE__)
 

Definition at line 218 of file messageStream.H.

#define SeriousIOErrorIn fn,
ios   )     SeriousError(fn, __FILE__, __LINE__, ios)
 

Definition at line 219 of file messageStream.H.

#define WarningIn fn   )     Warning(fn, __FILE__, __LINE__)
 

Definition at line 221 of file messageStream.H.


Variable Documentation

messageStream Info
 

Referenced by HashTable::begin(), Foam::mapClouds(), ParRunControl::runPar(), and ParRunControl::~ParRunControl().

messageStream SeriousError
 

messageStream Warning
 

For further information go to www.openfoam.org