00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::Callback 00026 00027 Description 00028 Abstract class to handle automatic call-back registration with the 00029 CallbackRegistry. Derive from this class and extend by adding the 00030 appropriate callback functions. 00031 00032 SourceFiles 00033 Callback.C 00034 00035 \*---------------------------------------------------------------------------*/ 00036 00037 #ifndef Callback_H 00038 #define Callback_H 00039 00040 #include <OpenFOAM/CallbackRegistry.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class Callback Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 template<class CallbackType> 00052 class Callback 00053 : 00054 public CallbackRegistry<CallbackType>::link 00055 { 00056 // Private data 00057 00058 //- CallbackRegistry reference 00059 CallbackRegistry<CallbackType>& cbr_; 00060 00061 00062 // Private Member Functions 00063 00064 //- Disallow default bitwise assignment 00065 void operator=(const Callback<CallbackType>&); 00066 00067 00068 public: 00069 00070 // Constructors 00071 00072 //- Construct and register with CallbackRegistry 00073 Callback(CallbackRegistry<CallbackType>&); 00074 00075 //- Construct as copy 00076 Callback(const Callback<CallbackType>&); 00077 00078 00079 // Destructor 00080 00081 virtual ~Callback(); 00082 00083 00084 // Member functions 00085 00086 // Registration 00087 00088 //- Register Callback with CallbackRegistry 00089 bool checkIn(); 00090 00091 //- Check-out Callback from CallbackRegistry 00092 bool checkOut(); 00093 }; 00094 00095 00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00097 00098 } // End namespace Foam 00099 00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00101 00102 #ifdef NoRepository 00103 # include <OpenFOAM/Callback.C> 00104 #endif 00105 00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00107 00108 #endif 00109 00110 // ************************ vim: set sw=4 sts=4 et: ************************ //
