src/gdcmRefCounter.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmRefCounter.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/26 15:41:29 $
   7   Version:   $Revision: 1.8 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMREFCOUNTER_H
  20 #define GDCMREFCOUNTER_H
  21
  22 #include "gdcmBase.h"
  23 #include "gdcmDebug.h"
  24
  25 namespace gdcm
  26 {
  27 //-----------------------------------------------------------------------------
  28 /**
  29  * \brief Integration of reference counting with a destruction of the
  30  *        object only when the reference is to zero
  31  */
  32 class GDCM_EXPORT RefCounter : public Base
  33 {
  34    gdcmTypeMacro(RefCounter);
  35
  36 public:
  37 // Allocator / Unallocator
  38    /// \brief Delete the object
  39    /// \remarks The object is deleted only if its reference counting is to zero
  40    void Delete() { Unregister(); }
  41
  42 // Reference count
  43    /// \brief Register the object
  44    /// \remarks It increments the reference counting
  45    void Register() { RefCount++; }
  46
  47    /// \brief Unregister the object
  48    /// \remarks It decrements the reference counting
  49    void Unregister()
  50    {
  51       RefCount--;
  52       if(RefCount<=0)
  53          delete this;
  54    }
  55    /// \brief Get the reference counting
  56    /// \return Reference count
  57    const unsigned long &GetRefCount() const
  58    {
  59       return RefCount;
  60    }
  61
  62 protected:
  63    /// Constructor
  64    RefCounter() { RefCount = 1; }
  65    /// Destructor
  66    virtual ~RefCounter() {}
  67
  68 private:
  69    /// \brief Reference count
  70    unsigned long RefCount;
  71 };
  72 } // end namespace gdcm
  73
  74 //-----------------------------------------------------------------------------
  75 #endif