Callback.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 Class
25  Foam::Callback
26 
27 Description
28  Abstract class to handle automatic call-back registration with the
29  CallbackRegistry. Derive from this class and extend by adding the
30  appropriate callback functions.
31 
32 SourceFiles
33  Callback.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef Callback_H
38 #define Callback_H
39 
40 #include "CallbackRegistry.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class Callback Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class CallbackType>
52 class Callback
53 :
54  public CallbackRegistry<CallbackType>::link
55 {
56  // Private data
57 
58  //- CallbackRegistry reference
60 
61 
62  // Private Member Functions
63 
64  //- Disallow default bitwise assignment
65  void operator=(const Callback<CallbackType>&);
66 
67 
68 public:
69 
70  // Constructors
71 
72  //- Construct and register with CallbackRegistry
74 
75  //- Construct as copy
77 
78 
79  //- Destructor
80  virtual ~Callback();
81 
82 
83  // Member functions
84 
85  // Registration
86 
87  //- Register Callback with CallbackRegistry
88  bool checkIn();
89 
90  //- Check-out Callback from CallbackRegistry
91  bool checkOut();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #ifdef NoRepository
102 # include "Callback.C"
103 #endif
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
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
Namespace for OpenFOAM.
Base class with which callbacks are registered.