All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
regIOobjectI.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) 2011-2022 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
28 inline bool Foam::regIOobject::registered() const
29 {
30  return registered_;
31 }
32 
33 
35 {
36  return ownedByRegistry_;
37 }
38 
39 
41 {
42  checkIn();
43  ownedByRegistry_ = true;
44 }
45 
46 
47 template<class Type>
48 inline Type& Foam::regIOobject::store(Type* tPtr)
49 {
50  if (!tPtr)
51  {
53  << "object deallocated"
54  << abort(FatalError);
55  }
56 
57  tPtr->regIOobject::checkIn();
58  tPtr->regIOobject::ownedByRegistry_ = true;
59 
60  return *tPtr;
61 }
62 
63 
64 template<class Type>
66 {
67  Type* tPtr = atPtr.ptr();
68 
69  if (!tPtr)
70  {
72  << "object deallocated"
73  << abort(FatalError);
74  }
75 
76  tPtr->regIOobject::checkIn();
77  tPtr->regIOobject::ownedByRegistry_ = true;
78 
79  return *tPtr;
80 }
81 
82 
84 {
85  ownedByRegistry_ = false;
86 }
87 
88 
90 {
91  return eventNo_;
92 }
93 
95 {
96  return eventNo_;
97 }
98 
99 
101 {
102  return watchIndices_;
103 }
104 
105 
107 {
108  return watchIndices_;
109 }
110 
111 
112 // ************************************************************************* //
error FatalError
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:306
const labelList & watchIndices() const
Return file-monitoring handles.
Definition: regIOobjectI.H:100
void release()
Release ownership of this object from its registry.
Definition: regIOobjectI.H:83
T * ptr()
Return object pointer for reuse.
Definition: autoPtrI.H:90
bool ownedByRegistry() const
Is this object owned by the registry?
Definition: regIOobjectI.H:34
bool registered() const
Is this object registered with the registry?
Definition: regIOobjectI.H:28
label eventNo() const
Event number at last update.
Definition: regIOobjectI.H:89
errorManip< error > abort(error &err)
Definition: errorManip.H:131
void store()
Transfer ownership of this object to its registry.
Definition: regIOobjectI.H:40
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
bool checkIn()
Add object to registry.
Definition: regIOobject.C:205