threadedCollatedOFstream.H
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 Class
25  Foam::threadedCollatedOFstream
26 
27 Description
28  Master-only drop-in replacement for OFstream.
29 
30 SourceFiles
31  threadedCollatedOFstream.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef threadedCollatedOFstream_H
36 #define threadedCollatedOFstream_H
37 
38 #include "OStringStream.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class OFstreamCollator;
46 
47 /*---------------------------------------------------------------------------*\
48  Class threadedCollatedOFstream Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public OStringStream
54 {
55  // Private Data
56 
57  OFstreamCollator& writer_;
58 
59  const fileName filePath_;
60 
61  const IOstream::compressionType compression_;
62 
63  const bool useThread_;
64 
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct and set stream status
72  (
74  const fileName& filePath,
78  const bool useThread = true
79  );
80 
81 
82  //- Destructor
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
Threaded file writer.
A class for handling file names.
Definition: fileName.H:79
Master-only drop-in replacement for OFstream.
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.
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
streamFormat format() const
Return current stream format.
Definition: IOstream.H:374
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:193
compressionType compression() const
Return the stream compression.
Definition: IOstream.H:413
static const versionNumber currentVersion
Current version number.
Definition: IOstream.H:203
Version number type.
Definition: IOstream.H:96
Output to memory buffer stream.
Definition: OStringStream.H:49
Namespace for OpenFOAM.