masterOFstream.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::masterOFstream
26 
27 Description
28  Master-only drop-in replacement for OFstream.
29 
30 SourceFiles
31  masterOFstream.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef masterOFstream_H
36 #define masterOFstream_H
37 
38 #include "OStringStream.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class masterOFstream Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class masterOFstream
50 :
51  public OStringStream
52 {
53  // Private Data
54 
55  const fileName filePath_;
56 
57  const IOstream::compressionType compression_;
58 
59  const bool append_;
60 
61  //- Should file be written
62  const bool write_;
63 
64 
65  // Private Member Functions
66 
67  //- Open file with checking
68  void checkWrite(const fileName& fName, const string& str);
69 
70 
71 public:
72 
73  // Constructors
74 
75  //- Construct and set stream status
77  (
78  const fileName& filePath,
82  const bool append = false,
83  const bool write = true
84  );
85 
86 
87  //- Destructor
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
Version number type.
Definition: IOstream.H:97
static const versionNumber currentVersion
Current version number.
Definition: IOstream.H:203
streamFormat format() const
Return current stream format.
Definition: IOstream.H:374
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:87
versionNumber version() const
Return the stream version.
Definition: IOstream.H:396
compressionType compression() const
Return the stream compression.
Definition: IOstream.H:413
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:194
virtual Ostream & write(const char)
Write character.
Definition: OSstream.C:32
Output to memory buffer stream.
Definition: OStringStream.H:52
string str() const
Return the string.
A class for handling file names.
Definition: fileName.H:82
Master-only drop-in replacement for OFstream.
masterOFstream(const fileName &filePath, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED, const bool append=false, const bool write=true)
Construct and set stream status.
~masterOFstream()
Destructor.
Namespace for OpenFOAM.