threadedCollatedOFstream.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
27 #include "decomposedBlockData.H"
28 #include "OFstreamCollator.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
33 (
34  OFstreamCollator& writer,
35  const fileName& filePath,
36  streamFormat format,
37  versionNumber version,
38  compressionType compression,
39  const bool useThread
40 )
41 :
42  OStringStream(format, version),
43  writer_(writer),
44  filePath_(filePath),
45  compression_(compression),
46  useThread_(useThread)
47 {}
48 
49 
50 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
51 
53 {
54  writer_.write
55  (
56  decomposedBlockData::typeName,
57  filePath_,
58  str(),
60  version(),
61  compression_,
62  false, // append
63  useThread_
64  );
65 }
66 
67 
68 // ************************************************************************* //
Threaded file writer.
A class for handling file names.
Definition: fileName.H:79
versionNumber version() const
Return the stream version.
Definition: IOstream.H:396
threadedCollatedOFstream(OFstreamCollator &, const fileName &filePath, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED, const bool useThread=true)
Construct and set stream status.
bool write(const word &typeName, const fileName &, const string &data, IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool append, const bool useThread=true)
Write file with contents. Blocks until writethread has space.
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:193
string str() const
Return the string.
Version number type.
Definition: IOstream.H:96
Output to memory buffer stream.
Definition: OStringStream.H:49