src/OpenFOAM/memory/tmp/refCount.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::refCount
  27
  28 Description
  29     Reference counter for tmp\<field\>.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef refCount_H
  34 #define refCount_H
  35
  36 #include "bool.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                           Class refCount Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 class refCount
  48 {
  49     // Private data
  50
  51         int count_;
  52
  53     // Private member functions
  54
  55         //- Dissallow copy
  56         refCount(const refCount&);
  57
  58         //- Dissallow bitwise assignment
  59         void operator=(const refCount&);
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct null with zero count
  67         refCount()
  68         :
  69             count_(0)
  70         {}
  71
  72
  73     // Member Functions
  74
  75         //- Return the reference count
  76         int count() const
  77         {
  78             return count_;
  79         }
  80
  81
  82         //- Return true if the reference count is zero
  83         bool okToDelete() const
  84         {
  85             return !count_;
  86         }
  87
  88
  89         //- Reset the reference count to zero
  90         void resetRefCount()
  91         {
  92             count_ = 0;
  93         }
  94
  95
  96     // Member Operators
  97
  98         //- Increment the reference count
  99         void operator++()
 100         {
 101             count_++;
 102         }
 103
 104         //- Increment the reference count
 105         void operator++(int)
 106         {
 107             count_++;
 108         }
 109
 110         //- Decrement the reference count
 111         void operator--()
 112         {
 113             count_--;
 114         }
 115
 116         //- Decrement the reference count
 117         void operator--(int)
 118         {
 119             count_--;
 120         }
 121 };
 122
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 } // End namespace Foam
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #endif
 131
 132 // ************************************************************************* //