src/foam/db/Callback/Callback.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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
  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 "Callback.C"
 104 #endif
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #endif
 109
 110 // ************************************************************************* //