PCL
ReferenceCounter.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/ReferenceCounter.h - Released 2019-11-07T10:59:34Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ReferenceCounter_h
53 #define __PCL_ReferenceCounter_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/Atomic.h>
60 
61 #ifdef __PCL_REFCOUNT_CHECK_DETACHMENT
62 # include <pcl/Exception.h>
63 #else
64 # include <pcl/Diagnostics.h>
65 #endif
66 
67 namespace pcl
68 {
69 
70 // ----------------------------------------------------------------------------
71 
99 class PCL_CLASS ReferenceCounter
100 {
101 public:
102 
108  ReferenceCounter() : m_count( 1 )
109  {
110  }
111 
116  {
117  }
118 
129  {
130  }
131 
136  ReferenceCounter& operator =( const ReferenceCounter& ) = delete;
137 
147  void Attach()
148  {
149  m_count.Increment();
150  }
151 
166  bool Detach()
167  {
168  PCL_CHECK( m_count.Load() > 0 )
169  return m_count.Dereference();
170  }
171 
177  int RefCount() const
178  {
179  return m_count;
180  }
181 
190  int RefCountAtomic() const
191  {
192  return m_count.Load();
193  }
194 
201  bool IsUnique() const
202  {
203  return RefCount() < 2;
204  }
205 
215  bool IsUniqueAtomic() const
216  {
217  return RefCountAtomic() < 2;
218  }
219 
220 private:
221 
222  mutable AtomicInt m_count;
223 };
224 
225 // ----------------------------------------------------------------------------
226 
227 } // pcl
228 
229 #endif // __PCL_ReferenceCounter_h
230 
231 // ----------------------------------------------------------------------------
232 // EOF pcl/ReferenceCounter.h - Released 2019-11-07T10:59:34Z
Atomic operations on integers.
Definition: Atomic.h:94
PCL root namespace.
Definition: AbstractImage.h:76
ReferenceCounter(const ReferenceCounter &)
Thread-safe reference counter for copy-on-write data structures.