FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

refCount.H

Go to the documentation of this file.
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::refCount
00026 
00027 Description
00028     Reference counter for tmp<field>.
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef refCount_H
00033 #define refCount_H
00034 
00035 #include <OpenFOAM/bool.H>
00036 
00037 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00038 
00039 namespace Foam
00040 {
00041 
00042 /*---------------------------------------------------------------------------*\
00043                           Class refCount Declaration
00044 \*---------------------------------------------------------------------------*/
00045 
00046 class refCount
00047 {
00048     // Private data
00049 
00050         int count_;
00051 
00052     // Private member functions
00053 
00054         //- Dissallow copy
00055         refCount(const refCount&);
00056 
00057         //- Dissallow bitwise assignment
00058         void operator=(const refCount&);
00059 
00060 
00061 public:
00062 
00063     // Constructors
00064 
00065         //- Construct null with zero count
00066         refCount()
00067         :
00068             count_(0)
00069         {}
00070 
00071 
00072     // Member Functions
00073 
00074         //- Return the reference count
00075         int count() const
00076         {
00077             return count_;
00078         }
00079 
00080 
00081         //- Return true if the reference count is zero
00082         bool okToDelete() const
00083         {
00084             return !count_;
00085         }
00086 
00087 
00088         //- Reset the reference count to zero
00089         void resetRefCount()
00090         {
00091             count_ = 0;
00092         }
00093 
00094 
00095     // Member Operators
00096 
00097         //- Increment the reference count
00098         void operator++()
00099         {
00100             count_++;
00101         }
00102 
00103         //- Increment the reference count
00104         void operator++(int)
00105         {
00106             count_++;
00107         }
00108 
00109         //- Decrement the reference count
00110         void operator--()
00111         {
00112             count_--;
00113         }
00114 
00115         //- Decrement the reference count
00116         void operator--(int)
00117         {
00118             count_--;
00119         }
00120 };
00121 
00122 
00123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00124 
00125 } // End namespace Foam
00126 
00127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00128 
00129 #endif
00130 
00131 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines