Callback.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 | 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 #include "Callback.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class CallbackType>
32 :
33  cbr_(cbr)
34 {
35  checkIn();
36 }
37 
38 
39 template<class CallbackType>
41 :
42  cbr_(cb.cbr_)
43 {
44  checkIn();
45 }
46 
47 
48 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
49 
50 template<class CallbackType>
52 {
53  checkOut();
54 }
55 
56 
57 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
58 
59 template<class CallbackType>
61 {
63  {
64  cbr_.append(static_cast<CallbackType*>(this));
65  return true;
66  }
67  else
68  {
69  return false;
70  }
71 }
72 
73 
74 template<class CallbackType>
76 {
78  {
79  CallbackType* cbPtr = cbr_.remove(static_cast<CallbackType*>(this));
80 
81  if (cbPtr)
82  {
83  return true;
84  }
85  else
86  {
87  return false;
88  }
89  }
90  else
91  {
92  return false;
93  }
94 }
95 
96 
97 // ************************************************************************* //
bool checkIn()
Register Callback with CallbackRegistry.
Definition: Callback.C:60
Callback(CallbackRegistry< CallbackType > &)
Construct and register with CallbackRegistry.
Definition: Callback.C:31
virtual ~Callback()
Destructor.
Definition: Callback.C:51
Abstract class to handle automatic call-back registration with the CallbackRegistry. Derive from this class and extend by adding the appropriate callback functions.
Definition: Callback.H:51
bool checkOut()
Check-out Callback from CallbackRegistry.
Definition: Callback.C:75
Base class with which callbacks are registered.