ITK  5.4.0
Insight Toolkit
itkObjectFactoryBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkObjectFactoryBase_h
29 #define itkObjectFactoryBase_h
30 
32 #include "itkSingletonMacro.h"
33 #include "itkCommonEnums.h"
34 #include <list>
35 #include <memory> // For unique_ptr.
36 #include <vector>
37 
38 namespace itk
39 {
59 class ITKCommon_EXPORT ObjectFactoryBase : public Object
60 {
61 public:
62  ITK_DISALLOW_COPY_AND_MOVE(ObjectFactoryBase);
63 
66  using Superclass = Object;
69 
71  itkTypeMacro(ObjectFactoryBase, Object);
72 
78  CreateInstance(const char * itkclassname);
79 
84  static std::list<LightObject::Pointer>
85  CreateAllInstance(const char * itkclassname);
86 
89  static void
90  ReHash();
91 
99  static void
100  RegisterFactoryInternal(ObjectFactoryBase *);
101 
103 #if !defined(ITK_LEGACY_REMOVE)
104  // We need to expose the enum values at the class level
105  // for backwards compatibility
106  static constexpr InsertionPositionEnum INSERT_AT_FRONT = InsertionPositionEnum::INSERT_AT_FRONT;
107  static constexpr InsertionPositionEnum INSERT_AT_BACK = InsertionPositionEnum::INSERT_AT_BACK;
108  static constexpr InsertionPositionEnum INSERT_AT_POSITION = InsertionPositionEnum::INSERT_AT_POSITION;
109 #endif
110 
129  static bool
130  RegisterFactory(ObjectFactoryBase *,
131  InsertionPositionEnum where = InsertionPositionEnum::INSERT_AT_BACK,
132  size_t position = 0);
136  static void
137  UnRegisterFactory(ObjectFactoryBase *);
138 
140  static void
141  UnRegisterAllFactories();
142 
145  static std::list<ObjectFactoryBase *>
146  GetRegisteredFactories();
147 
153  virtual const char *
154  GetITKSourceVersion() const = 0;
155 
161  static void
162  SetStrictVersionChecking(bool);
163  static void
164  StrictVersionCheckingOn();
165  static void
166  StrictVersionCheckingOff();
167  static bool
168  GetStrictVersionChecking();
172  virtual const char *
173  GetDescription() const = 0;
174 
176  virtual std::list<std::string>
177  GetClassOverrideNames();
178 
180  virtual std::list<std::string>
181  GetClassOverrideWithNames();
182 
184  virtual std::list<std::string>
185  GetClassOverrideDescriptions();
186 
188  virtual std::list<bool>
189  GetEnableFlags();
190 
192  virtual void
193  SetEnableFlag(bool flag, const char * className, const char * subclassName);
194 
196  virtual bool
197  GetEnableFlag(const char * className, const char * subclassName);
198 
202  virtual void
203  Disable(const char * className);
204 
206  const char *
207  GetLibraryPath();
208 
211  template <typename TFactory>
212  static void
214  {
215  struct FactoryRegistration
216  {};
217 
218  // Factory registration, made thread-safe by "magic statics" (as introduced with C++11).
219  static const FactoryRegistration staticFactoryRegistration = [] {
220  RegisterFactoryInternal(TFactory::New());
221  return FactoryRegistration{};
222  }();
223 
224  (void)staticFactoryRegistration;
225  }
226 
229  static void
230  Initialize();
231 
232 protected:
233  void
234  PrintSelf(std::ostream & os, Indent indent) const override;
235 
237  void
238  RegisterOverride(const char * classOverride,
239  const char * subclass,
240  const char * description,
241  bool enableFlag,
242  CreateObjectFunctionBase * createFunction);
243 
247  virtual LightObject::Pointer
248  CreateObject(const char * itkclassname);
249 
253  virtual std::list<LightObject::Pointer>
254  CreateAllObject(const char * itkclassname);
255 
257  ~ObjectFactoryBase() override;
258 
259 private:
260  // Forward reference because of private implementation
261  class OverrideMap;
262  class ObjectFactoryBasePrivate;
263 
266  static void
267  SynchronizeObjectFactoryBase(void * objectFactoryBasePrivate);
268  itkGetGlobalDeclarationMacro(ObjectFactoryBasePrivate, PimplGlobals);
271  const std::unique_ptr<OverrideMap> m_OverrideMap;
272 
274  static void
275  InitializeFactoryList();
276 
278  static void
279  RegisterInternal();
280 
282  static void
283  LoadDynamicFactories();
284 
286  static void
287  LoadLibrariesInPath(const char *);
288 
289  static void
290  DeleteNonInternalFactory(ObjectFactoryBase *);
291 
294  void * m_LibraryHandle{};
295  unsigned long m_LibraryDate{};
296  std::string m_LibraryPath{};
297 
298  static ObjectFactoryBasePrivate * m_PimplGlobals;
299 };
300 } // end namespace itk
301 
302 #endif
itkCreateObjectFunction.h
itk::ObjectFactoryBase
Create instances of classes using an object factory.
Definition: itkObjectFactoryBase.h:59
itkSingletonMacro.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::CreateObjectFunctionBase
Define API for object creation callback functions.
Definition: itkCreateObjectFunction.h:31
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ObjectFactoryBase::m_PimplGlobals
static ObjectFactoryBasePrivate * m_PimplGlobals
Definition: itkObjectFactoryBase.h:298
itk::ObjectFactoryBase::m_OverrideMap
const std::unique_ptr< OverrideMap > m_OverrideMap
Definition: itkObjectFactoryBase.h:271
itkCommonEnums.h
itkGetGlobalDeclarationMacro
#define itkGetGlobalDeclarationMacro(Type, VarName)
Definition: itkSingletonMacro.h:35
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:61
itk::ObjectFactoryEnums::InsertionPosition
InsertionPosition
Definition: itkCommonEnums.h:280
New
static Pointer New()
itk::ObjectFactoryBase::RegisterInternalFactoryOnce
static void RegisterInternalFactoryOnce()
Definition: itkObjectFactoryBase.h:213