All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
baseIOdictionaryIO.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) 2011-2018 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 
26 #include "baseIOdictionary.H"
27 #include "Pstream.H"
28 
29 // * * * * * * * * * * * * * * * Members Functions * * * * * * * * * * * * * //
30 
32 {
33  is >> *this;
34 
35  if (writeDictionaries && Pstream::master() && !is.bad())
36  {
37  Sout<< nl
38  << "--- baseIOdictionary " << name()
39  << ' ' << objectPath() << ":" << nl;
41  writeData(Sout);
42  Sout<< "--- End of baseIOdictionary " << name() << nl << endl;
43  }
44 
45  return !is.bad();
46 }
47 
48 
50 {
51  dictionary::write(os, false);
52  return os.good();
53 }
54 
55 
56 // ************************************************************************* //
void write(Ostream &, const bool subDict=true) const
Write dictionary, normally with sub-dictionary formatting.
Definition: dictionaryIO.C:174
bool bad() const
Return true if stream is corrupted.
Definition: IOstream.H:351
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
static bool master(const label communicator=0)
Am I the master process.
Definition: UPstream.H:423
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:333
const word & name() const
Name function is needed to disambiguate those inherited.
OSstream Sout(cout, "Sout")
Definition: IOstreams.H:51
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
static const char nl
Definition: Ostream.H:260
bool writeHeader(Ostream &) const
Write header.
fileName objectPath() const
Return complete path + object name.
Definition: IOobject.H:419
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
virtual bool writeData(Ostream &) const
WriteData function required for regIOobject write operation.