File size: 6,045 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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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::OSstream
Description
Generic output stream.
SourceFiles
OSstreamI.H
OSstream.C
\*---------------------------------------------------------------------------*/
#ifndef OSstream_H
#define OSstream_H
#include "Ostream.H"
#include "fileName.H"
#include <iostream>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class OSstream Declaration
\*---------------------------------------------------------------------------*/
class OSstream
:
public Ostream
{
// Private Data
fileName name_;
ostream& os_;
public:
// Constructors
//- Set stream status
OSstream
(
ostream& os,
const string& name,
const streamFormat format = ASCII,
const versionNumber version = currentVersion,
const compressionType compression = UNCOMPRESSED
);
//- Copy construct
OSstream(const OSstream&) = default;
// Member Functions
// Enquiry
//- Return the name of the stream
// Useful for Fstream to return the filename
virtual const fileName& name() const
{
return name_;
}
//- Return non-const access to the name of the stream
// Useful to alter the stream name
virtual fileName& name()
{
return name_;
}
//- Return flags of output stream
virtual ios_base::fmtflags flags() const;
// 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 with double quotes
virtual Ostream& write(const string&);
//- Write keyType with optional ""
virtual Ostream& write(const keyType&);
//- Write verbatimString with #{ }#
virtual Ostream& write(const verbatimString&);
//- Write std::string with optional double 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();
// Stream state functions
//- Set flags of output stream
virtual ios_base::fmtflags flags(const ios_base::fmtflags flags);
//- Flush stream
virtual void flush();
//- Add newline and flush stream
virtual void endl();
//- Get width of output field
virtual int width() const;
//- Set width of output field (and return old width)
virtual int width(const int);
//- Get precision of output field
virtual int precision() const;
//- Set precision of output field (and return old precision)
virtual int precision(const int);
// STL stream
//- Access to underlying std::ostream
virtual ostream& stdStream()
{
return os_;
}
//- Const access to underlying std::ostream
virtual const ostream& stdStream() const
{
return os_;
}
// Print
//- Print description of IOstream to Ostream
virtual void print(Ostream&) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const OSstream&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "OSstreamI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|