regIOobjectI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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  ownedByRegistry_ = true;
37 }
38 
39 
40 template<class Type>
41 inline Type& Foam::regIOobject::store(Type* tPtr)
42 {
43  if (!tPtr)
44  {
45  FatalErrorIn("Type& regIOobject::store(Type*)")
46  << "object deallocated"
47  << abort(FatalError);
48  }
49 
50  tPtr->regIOobject::ownedByRegistry_ = true;
51 
52  return *tPtr;
53 }
54 
55 
56 template<class Type>
58 {
59  Type* tPtr = atPtr.ptr();
60 
61  if (!tPtr)
62  {
64  (
65  "Type& regIOobject::store(autoPtr<Type>&)"
66  ) << "object deallocated"
67  << abort(FatalError);
68  }
69 
70  tPtr->regIOobject::ownedByRegistry_ = true;
71 
72  return *tPtr;
73 }
74 
75 
77 {
78  ownedByRegistry_ = false;
79 }
80 
81 
83 {
84  return eventNo_;
85 }
86 
88 {
89  return eventNo_;
90 }
91 
92 
94 {
95  return watchIndex_;
96 }
97 
98 
100 {
101  return watchIndex_;
102 }
103 
104 
105 // ************************************************************************* //
T * ptr()
Return object pointer for reuse.
Definition: autoPtrI.H:90
label eventNo() const
Event number at last update.
Definition: regIOobjectI.H:82
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
void store()
Transfer ownership of this object to its registry.
Definition: regIOobjectI.H:34
label watchIndex() const
Return file-monitoring handle.
Definition: regIOobjectI.H:93
errorManip< error > abort(error &err)
Definition: errorManip.H:131
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
error FatalError
bool ownedByRegistry() const
Is this object owned by the registry?
Definition: regIOobjectI.H:28
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
void release()
Release ownership of this object from its registry.
Definition: regIOobjectI.H:76