File size: 4,628 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ 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,
const streamFormat format = ASCII,
const versionNumber version = currentVersion,
const 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 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 verbatimString
virtual Ostream& write(const verbatimString&);
//- Write std::string surrounded by quotes.
// Optional write without quotes.
virtual Ostream& writeQuoted
(
const std::string&,
const bool quoted=true
);
//- Write int32_t
virtual Ostream& write(const int32_t);
//- Write int64_t
virtual Ostream& write(const int64_t);
//- Write int32_t
virtual Ostream& write(const uint32_t);
//- Write int64_t
virtual Ostream& write(const uint64_t);
//- Write floatScalar
virtual Ostream& write(const floatScalar);
//- Write doubleScalar
virtual Ostream& write(const doubleScalar);
//- Write longDoubleScalar
virtual Ostream& write(const longDoubleScalar);
//- 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
// ************************************************************************* //
|