OpenFOAM logo
Open Source CFD Toolkit

messageStream Class Reference

Inheritance diagram for messageStream:

Inheritance graph
[legend]
Collaboration diagram for messageStream:

Collaboration graph
[legend]
List of all members.

Public Types

enum  errorSeverity { INFO, WARNING, SERIOUS, FATAL }
 Severity flags. More...

Public Member Functions

 messageStream (const string &title, errorSeverity sev, const int maxErrors=0)
 Construct from components.
 messageStream (const dictionary &dict)
 Construct from dictionary.
const stringtitle () const
 Return the title of this error type.
int maxErrors () const
 Return the maximum number of errors before program termination.
int & maxErrors ()
 Return non-const access to the maximum number of errors before.
OSstreamoperator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
 Convert to Ostream.
OSstreamoperator() (const string &functionName, const char *sourceFileName, const int sourceFileLineNumber=0)
OSstreamoperator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const string &ioFileName, const label ioStartLineNumber=-1, const label ioEndLineNumber=-1)
 Convert to Ostream.
OSstreamoperator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &)
 Convert to Ostream.
OSstreamoperator() (const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const dictionary &)
 Convert to Ostream.
 operator OSstream & ()
 Convert to Ostream.

Static Public Attributes

int level

Protected Attributes

string title_
errorSeverity severity_
int maxErrors_
int errorCount_

Member Enumeration Documentation

enum errorSeverity
 

Severity flags.

Enumeration values:
INFO 
WARNING 
SERIOUS 
FATAL 

Definition at line 80 of file messageStream.H.


Constructor & Destructor Documentation

messageStream const string title,
errorSeverity  sev,
const int  maxErrors = 0
 

Construct from components.

messageStream const dictionary dict  ) 
 

Construct from dictionary.


Member Function Documentation

int& maxErrors  )  [inline]
 

Return non-const access to the maximum number of errors before.

program termination to enable user to reset it

Definition at line 139 of file messageStream.H.

References Foam::label.

int maxErrors  )  const [inline]
 

Return the maximum number of errors before program termination.

Definition at line 130 of file messageStream.H.

operator OSstream &  ) 
 

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented in error.

OSstream& operator() const char *  functionName,
const char *  sourceFileName,
const int  sourceFileLineNumber,
const dictionary
 

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented in IOerror.

OSstream& operator() const char *  functionName,
const char *  sourceFileName,
const int  sourceFileLineNumber,
const IOstream
 

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented in IOerror.

OSstream& operator() const char *  functionName,
const char *  sourceFileName,
const int  sourceFileLineNumber,
const string ioFileName,
const label  ioStartLineNumber = -1,
const label  ioEndLineNumber = -1
 

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented in IOerror.

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

Reimplemented in error.

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

Convert to Ostream.

Prints basic message and then returns Ostream for further info.

Reimplemented in error.

const string& title  )  const [inline]
 

Return the title of this error type.

Definition at line 124 of file messageStream.H.


Member Data Documentation

int errorCount_ [protected]
 

Definition at line 96 of file messageStream.H.

int level [static]
 

Definition at line 103 of file messageStream.H.

int maxErrors_ [protected]
 

Definition at line 95 of file messageStream.H.

errorSeverity severity_ [protected]
 

Definition at line 94 of file messageStream.H.

string title_ [protected]
 

Definition at line 93 of file messageStream.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org