mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
156 lines
4.1 KiB
C++
156 lines
4.1 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
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 3 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::prefixOSstream
|
|
|
|
Description
|
|
Version of OSstream which prints a prefix on each line.
|
|
|
|
This is useful for running in parallel as it allows the processor number
|
|
to be automatically prepended to each message line.
|
|
|
|
SourceFiles
|
|
prefixOSstream.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef prefixOSstream_H
|
|
#define prefixOSstream_H
|
|
|
|
#include "OSstream.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class prefixOSstream Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class prefixOSstream
|
|
:
|
|
public OSstream
|
|
{
|
|
// Private data
|
|
|
|
bool printPrefix_;
|
|
string prefix_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
inline void checkWritePrefix();
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Set stream status
|
|
prefixOSstream
|
|
(
|
|
ostream& os,
|
|
const string& name,
|
|
streamFormat format=ASCII,
|
|
versionNumber version=currentVersion,
|
|
compressionType compression=UNCOMPRESSED
|
|
);
|
|
|
|
|
|
// Member functions
|
|
|
|
// Enquiry
|
|
|
|
//- Return the prefix of the stream
|
|
const string& prefix() const
|
|
{
|
|
return prefix_;
|
|
}
|
|
|
|
//- Return non-const access to the prefix of the stream
|
|
string& prefix()
|
|
{
|
|
return prefix_;
|
|
}
|
|
|
|
|
|
// Write functions
|
|
|
|
//- Write next token to stream
|
|
virtual Ostream& write(const token&);
|
|
|
|
//- Write character
|
|
virtual Ostream& write(const char);
|
|
|
|
//- Write character string
|
|
virtual Ostream& write(const char*);
|
|
|
|
//- Write word
|
|
virtual Ostream& write(const word&);
|
|
|
|
//- Write string
|
|
virtual Ostream& write(const string&);
|
|
|
|
//- Write std::string surrounded by quotes.
|
|
// Optional write without quotes.
|
|
virtual Ostream& writeQuoted
|
|
(
|
|
const std::string&,
|
|
const bool quoted=true
|
|
);
|
|
|
|
//- Write label
|
|
virtual Ostream& write(const label);
|
|
|
|
//- Write floatScalar
|
|
virtual Ostream& write(const floatScalar);
|
|
|
|
//- Write doubleScalar
|
|
virtual Ostream& write(const doubleScalar);
|
|
|
|
//- Write binary block
|
|
virtual Ostream& write(const char*, std::streamsize);
|
|
|
|
//- Add indentation characters
|
|
virtual void indent();
|
|
|
|
|
|
// Print
|
|
|
|
//- Print description of IOstream to Ostream
|
|
virtual void print(Ostream&) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|