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-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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return ownedByRegistry_;
31 }
32 
33 
35 {
36  checkIn();
37  ownedByRegistry_ = true;
38 }
39 
40 
41 template<class Type>
42 inline Type& Foam::regIOobject::store(Type* tPtr)
43 {
44  if (!tPtr)
45  {
47  << "object deallocated"
48  << abort(FatalError);
49  }
50 
51  tPtr->regIOobject::checkIn();
52  tPtr->regIOobject::ownedByRegistry_ = true;
53 
54  return *tPtr;
55 }
56 
57 
58 template<class Type>
60 {
61  Type* tPtr = atPtr.ptr();
62 
63  if (!tPtr)
64  {
66  << "object deallocated"
67  << abort(FatalError);
68  }
69 
70  tPtr->regIOobject::checkIn();
71  tPtr->regIOobject::ownedByRegistry_ = true;
72 
73  return *tPtr;
74 }
75 
76 
78 {
79  ownedByRegistry_ = false;
80 }
81 
82 
84 {
85  return eventNo_;
86 }
87 
89 {
90  return eventNo_;
91 }
92 
93 
95 {
96  return watchIndices_;
97 }
98 
99 
101 {
102  return watchIndices_;
103 }
104 
105 
106 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
error FatalError
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
const labelList & watchIndices() const
Return file-monitoring handles.
Definition: regIOobjectI.H:94
void release()
Release ownership of this object from its registry.
Definition: regIOobjectI.H:77
T * ptr()
Return object pointer for reuse.
Definition: autoPtrI.H:90
bool ownedByRegistry() const
Is this object owned by the registry?
Definition: regIOobjectI.H:28
label eventNo() const
Event number at last update.
Definition: regIOobjectI.H:83
errorManip< error > abort(error &err)
Definition: errorManip.H:131
void store()
Transfer ownership of this object to its registry.
Definition: regIOobjectI.H:34
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:175