ReferenceCounter.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/ReferenceCounter.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_ReferenceCounter_h
#define __PCL_ReferenceCounter_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Atomic.h>
 
#ifdef __PCL_REFCOUNT_CHECK_DETACHMENT
#  include <pcl/Exception.h>
#else
#  include <pcl/Diagnostics.h>
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ReferenceCounter
{
public:
 
   ReferenceCounter() = default;
 
   ~ReferenceCounter()
   {
   }
 
   ReferenceCounter( const ReferenceCounter& )
      : ReferenceCounter()
   {
   }
 
   ReferenceCounter& operator =( const ReferenceCounter& ) = delete;
 
   void Attach()
   {
      m_count.Increment();
   }
 
   bool Detach()
   {
      PCL_CHECK( m_count.Load() > 0 )
      return m_count.Dereference();
   }
 
   int RefCount() const
   {
      return m_count;
   }
 
   int RefCountAtomic() const
   {
      return m_count.Load();
   }
 
   bool IsUnique() const
   {
      return RefCount() < 2;
   }
 
   bool IsUniqueAtomic() const
   {
      return RefCountAtomic() < 2;
   }
 
private:
 
   mutable AtomicInt m_count = 1;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif  // __PCL_ReferenceCounter_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ReferenceCounter.h - Released 2024-05-07T15:27:32Z