src/OpenFOAM/db/Callback/Callback.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::Callback
  27
  28 Description
  29     Abstract class to handle automatic call-back registration with the
  30     CallbackRegistry.  Derive from this class and extend by adding the
  31     appropriate callback functions.
  32
  33 SourceFiles
  34     Callback.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef Callback_H
  39 #define Callback_H
  40
  41 #include "CallbackRegistry.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class Callback Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class CallbackType>
  53 class Callback
  54 :
  55     public CallbackRegistry<CallbackType>::link
  56 {
  57     // Private data
  58
  59         //- CallbackRegistry reference
  60         CallbackRegistry<CallbackType>& cbr_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const Callback<CallbackType>&);
  67
  68
  69 public:
  70
  71     // Constructors
  72
  73         //- Construct and register with CallbackRegistry
  74         Callback(CallbackRegistry<CallbackType>&);
  75
  76         //- Construct as copy
  77         Callback(const Callback<CallbackType>&);
  78
  79
  80     // Destructor
  81
  82         virtual ~Callback();
  83
  84
  85     // Member functions
  86
  87         // Registration
  88
  89             //- Register Callback with CallbackRegistry
  90             bool checkIn();
  91
  92             //- Check-out Callback from CallbackRegistry
  93             bool checkOut();
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #ifdef NoRepository
 104 #   include "Callback.C"
 105 #endif
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //