PCL
MetaObject.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.4.1
6 // ----------------------------------------------------------------------------
7 // pcl/MetaObject.h - Released 2020-10-12T19:24:41Z
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-2020 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_MetaObject_h
53 #define __PCL_MetaObject_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 #include <pcl/Diagnostics.h>
61 
62 #include <pcl/IndirectArray.h>
63 
64 namespace pcl
65 {
66 
67 // ----------------------------------------------------------------------------
68 
85 class PCL_CLASS MetaObject
86 {
87 public:
88 
94 
99  : m_parent( parent )
100  {
101  if ( m_parent != nullptr )
102  m_parent->m_children.Add( this );
103  }
104 
108  virtual ~MetaObject() noexcept( false )
109  {
110  m_children.Destroy();
111  }
112 
117  MetaObject( const MetaObject& ) = delete;
118 
123  MetaObject& operator =( const MetaObject& ) = delete;
124 
129  MetaObject( MetaObject&& x ) = delete;
130 
135  MetaObject& operator =( MetaObject&& x ) = delete;
136 
141  {
142  return m_children.Length();
143  }
144 
148  const MetaObject* Parent() const
149  {
150  return m_parent;
151  }
152 
157  {
158  return m_parent;
159  }
160 
165  const MetaObject* operator[]( size_type i ) const
166  {
167  return m_children[i];
168  }
169 
170 protected:
171 
172  MetaObject* m_parent = nullptr;
173  children_list m_children;
174 
178  virtual void PerformAPIDefinitions() const = 0;
179 
180  friend class MetaModule;
181 };
182 
183 // ----------------------------------------------------------------------------
184 
185 } // pcl
186 
187 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
188 
189 #endif // __PCL_MetaObject_h
190 
191 // ----------------------------------------------------------------------------
192 // EOF pcl/MetaObject.h - Released 2020-10-12T19:24:41Z
const MetaObject * Parent() const
Definition: MetaObject.h:148
Root base class for all PixInsight module components.
Definition: MetaObject.h:85
size_type Length() const
Definition: MetaObject.h:140
MetaObject * Parent()
Definition: MetaObject.h:156
PCL root namespace.
Definition: AbstractImage.h:76
A formal description of a PixInsight module.
Definition: MetaModule.h:101
const MetaObject * operator[](size_type i) const
Definition: MetaObject.h:165
size_t size_type
Definition: Defs.h:557
virtual ~MetaObject() noexcept(false)
Definition: MetaObject.h:108
IndirectArray< MetaObject > children_list
Definition: MetaObject.h:93
MetaObject(MetaObject *parent)
Definition: MetaObject.h:98