* Add a RefCounter object that is deleted only when it's reference count is

[gdcm.git] / src / gdcmRefCounter.h

diff --git a/src/gdcmRefCounter.h b/src/gdcmRefCounter.h
new file mode 100644 (file)
index 0000000..cb3471a
--- /dev/null
+++ b/src/gdcmRefCounter.h
@@ -0,0 +1,83 @@
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmRefCounter.h,v $
+  Language:  C++
+  Date:      $Date: 2005/10/20 15:24:10 $
+  Version:   $Revision: 1.1 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
+#ifndef GDCMREFCOUNTER_H
+#define GDCMREFCOUNTER_H
+
+#include "gdcmBase.h"
+#include "gdcmDebug.h"
+
+namespace gdcm 
+{
+//-----------------------------------------------------------------------------
+/**
+ * \brief Integration of reference counting with a destruction of the
+ *        object only when the reference is to zero
+ */
+class GDCM_EXPORT RefCounter : public Base
+{
+public:
+   gdcmTypeMacro(RefCounter);
+
+public:
+// Allocator / Unallocator
+   /// Delete the object
+   /// \remarks The object is deleted only if its reference counting is to zero
+   inline virtual void Delete(void)
+   {
+      Unregister();
+   }
+
+// Reference count
+   /// Register the object
+   /// \remarks It increments the reference counting
+   inline void Register(void)
+   {
+      RefCount++;
+   }
+   /// Unregister the object
+   /// \remarks It decrements the reference counting
+   inline void Unregister(void)
+   {
+      RefCount--;
+      if(RefCount==0)
+      {
+         delete this;
+      }
+   }
+   /// Get the reference counting
+   /// \return Reference count
+   inline const unsigned long &GetRefCount(void) const
+   {
+      return(RefCount);
+   }
+
+protected:
+   /// Constructor
+   RefCounter() { RefCount = 1; }
+   /// Destructor
+   virtual ~RefCounter() {}
+
+private:
+   /// \brief Reference count
+   unsigned long RefCount;
+};
+} // end namespace gdcm
+
+//-----------------------------------------------------------------------------
+#endif