regIOobjectMetaData.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) 2021 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "regIOobject.H"
29 #include "dictionary.H"
30 
31 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32 
34 {
35  return metaDataPtr_.get();
36 }
37 
38 
40 {
41  if (!metaDataPtr_)
42  {
43  metaDataPtr_.reset(new dictionary("meta"));
44  }
45  return *metaDataPtr_;
46 }
47 
48 
50 {
51  metaDataPtr_.reset(nullptr);
52 }
53 
54 
56 {}
57 
58 
59 // ************************************************************************* //
regIOobject.H
Foam::regIOobject::updateMetaData
virtual void updateMetaData()
Update internal meta-data (eg, prior to writing)
Definition: regIOobjectMetaData.C:55
Foam::regIOobject::findMetaData
const dictionary * findMetaData() const noexcept
Return pointer to meta-data or nullptr.
Definition: regIOobjectMetaData.C:33
Foam::regIOobject::getMetaData
dictionary & getMetaData() noexcept
Get or create meta-data.
Definition: regIOobjectMetaData.C:39
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::regIOobject::removeMetaData
void removeMetaData()
Remove meta-data.
Definition: regIOobjectMetaData.C:49
dictionary.H