PCL
Container.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.6.5
6 // ----------------------------------------------------------------------------
7 // pcl/Container.h - Released 2024-01-13T15:47:58Z
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-2024 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 (https://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_Container_h
53 #define __PCL_Container_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 namespace pcl
60 {
61 
62 // ----------------------------------------------------------------------------
63 
68 class PCL_CLASS Container
69 {
70 };
71 
76 template <typename T>
77 class PCL_CLASS DirectContainer : public Container
78 {
79 public:
80 
81  using item_type = T;
82 };
83 
88 template <typename T>
89 class PCL_CLASS IndirectContainer : public Container
90 {
91 public:
92 
93  using item_type = T*;
94 };
95 
100 template <typename T>
101 class PCL_CLASS DirectSortedContainer: public DirectContainer<T>
102 {
103 };
104 
109 template <typename T>
110 class PCL_CLASS IndirectSortedContainer : public IndirectContainer<T>
111 {
112 };
113 
114 #define PCL_ASSERT_DIRECT_CONTAINER( C, T ) \
115  static_assert( std::is_base_of<DirectContainer<T>, C>::value, \
116  "Argument type must derive from DirectContainer<T>." )
117 
118 #define PCL_ASSERT_INDIRECT_CONTAINER( C, T ) \
119  static_assert( std::is_base_of<IndirectContainer<T>, C>::value, \
120  "Argument type must derive from IndirectContainer<T>." )
121 
122 #define PCL_ASSERT_CONTAINER( C, T ) \
123  static_assert( std::is_base_of<DirectContainer<T>, C>::value \
124  || std::is_base_of<IndirectContainer<T>, C>::value, \
125  "Argument type must derive from DirectContainer<T> or IndirectContainer<T>." )
126 
127 // ----------------------------------------------------------------------------
128 
129 } // pcl
130 
131 #endif // __PCL_Container_h
132 
133 // ----------------------------------------------------------------------------
134 // EOF pcl/Container.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition: AbstractImage.h:76
pcl::IndirectSortedContainer
Root base class of all PCL sorted containers of pointers to objects.
Definition: Container.h:110
pcl::Container
Root base class of all PCL containers.
Definition: Container.h:68
pcl::IndirectContainer
Root base class of all PCL containers of pointers to objects.
Definition: Container.h:89
pcl::DirectSortedContainer
Root base class of all PCL sorted containers of objects.
Definition: Container.h:101
pcl::DirectContainer
Root base class of all PCL containers of objects.
Definition: Container.h:77
Defs.h