IOdictionary.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "IOdictionary.H"
30 #include "objectRegistry.H"
31 #include "Pstream.H"
32 #include "Time.H"
33 
34 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
35 
37 (
38  const IOobject& io,
39  const dictionary* fallback
40 )
41 :
42  IOdictionary(io, typeName, fallback)
43 {}
44 
45 
47 (
48  const IOobject& io,
49  const dictionary& dict
50 )
51 :
52  IOdictionary(io, typeName, &dict)
53 {}
54 
55 
57 (
58  const IOobject& io,
59  const word& wantedType,
60  const dictionary* fallback
61 )
62 :
63  baseIOdictionary(io, fallback)
64 {
65  if (!readHeaderOk(IOstream::ASCII, wantedType) && fallback)
66  {
67  dictionary::operator=(*fallback);
68  }
69 
70  // For if MUST_READ_IF_MODIFIED
71  addWatch();
72 }
73 
74 
76 (
77  const IOobject& io,
78  Istream& is
79 )
80 :
81  baseIOdictionary(io, is)
82 {
83  // Default construct dictionary and read in afterwards
84  // so that if there is some fancy massaging due to a
85  // functionEntry in
86  // the dictionary at least the type information is already complete.
87  is >> *this;
88 
89  // For if MUST_READ_IF_MODIFIED
90  addWatch();
91 }
92 
93 
94 // ************************************************************************* //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
objectRegistry.H
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::baseIOdictionary
baseIOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO function...
Definition: baseIOdictionary.H:56
Foam::IOdictionary::IOdictionary
IOdictionary(const IOobject &io, const dictionary *fallback=nullptr)
Definition: IOdictionary.C:37
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Pstream.H
IOdictionary.H
Time.H