Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Class
Foam::Callback
Description
Abstract class to handle automatic call-back registration with the
CallbackRegistry. Derive from this class and extend by adding the
appropriate callback functions.
SourceFiles
Callback.C
\*---------------------------------------------------------------------------*/
#ifndef Callback_H
#define Callback_H
#include "CallbackRegistry.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class Callback Declaration
\*---------------------------------------------------------------------------*/
template<class CallbackType>
class Callback
:
public CallbackRegistry<CallbackType>::link
{
// Private data
//- CallbackRegistry reference
CallbackRegistry<CallbackType>& cbr_;
// Private Member Functions
//- No copy assignment
void operator=(const Callback<CallbackType>&) = delete;
public:
// Constructors
//- Construct and register with CallbackRegistry
Callback(CallbackRegistry<CallbackType>&);
//- Construct as copy
Callback(const Callback<CallbackType>&);
//- Destructor
virtual ~Callback();
// Member functions
// Registration
//- Register Callback with CallbackRegistry
bool checkIn();
//- Check-out Callback from CallbackRegistry
bool checkOut();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "Callback.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //