Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
Callback
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) 1991-2010 OpenCFD Ltd.
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 <
OpenFOAM/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
59
CallbackRegistry<CallbackType>
& cbr_;
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
73
Callback
(
CallbackRegistry<CallbackType>
&);
74
75
//- Construct as copy
76
Callback
(
const
Callback<CallbackType>
&);
77
78
79
// Destructor
80
81
virtual
~Callback
();
82
83
84
// Member functions
85
86
// Registration
87
88
//- Register Callback with CallbackRegistry
89
bool
checkIn
();
90
91
//- Check-out Callback from CallbackRegistry
92
bool
checkOut
();
93
};
94
95
96
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97
98
}
// End namespace Foam
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
#ifdef NoRepository
103
# include <
OpenFOAM/Callback.C
>
104
#endif
105
106
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108
#endif
109
110
// ************************ vim: set sw=4 sts=4 et: ************************ //