ITK
6.0.0
Insight Toolkit
|
#include <itkObjectFactoryBase.h>
Create instances of classes using an object factory.
ObjectFactoryBase is used to create itk objects. The base class ObjectFactoryBase contains a static method CreateInstance() that is used to create itk objects from the list of registered ObjectFactoryBase sub-classes. The first time CreateInstance() is called, all dll's or shared libraries in the environment variable ITK_AUTOLOAD_PATH are loaded into the current process. The C function itkLoad is called on each dll. itkLoad should return an instance of the factory sub-class implemented in the shared library. ITK_AUTOLOAD_PATH is an environment variable containing a colon separated (semi-colon on win32) list of paths.
This can be use to override the creation of any object in ITK.
Definition at line 59 of file itkObjectFactoryBase.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | InsertionPositionEnum = ObjectFactoryEnums::InsertionPosition |
using | Pointer = SmartPointer< Self > |
using | Self = ObjectFactoryBase |
using | Superclass = Object |
Public Types inherited from itk::Object | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = Object |
using | Superclass = LightObject |
Public Types inherited from itk::LightObject | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Public Member Functions | |
virtual void | Disable (const char *className) |
virtual std::list< std::string > | GetClassOverrideDescriptions () |
virtual std::list< std::string > | GetClassOverrideNames () |
virtual std::list< std::string > | GetClassOverrideWithNames () |
virtual const char * | GetDescription () const =0 |
virtual bool | GetEnableFlag (const char *className, const char *subclassName) |
virtual std::list< bool > | GetEnableFlags () |
virtual const char * | GetITKSourceVersion () const =0 |
const char * | GetLibraryPath () |
const char * | GetNameOfClass () const override |
virtual void | SetEnableFlag (bool flag, const char *className, const char *subclassName) |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
const char * | GetNameOfClass () const override |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Member Functions | |
static std::list< LightObject::Pointer > | CreateAllInstance (const char *itkclassname) |
static LightObject::Pointer | CreateInstance (const char *itkclassname) |
static std::list< ObjectFactoryBase * > | GetRegisteredFactories () |
static void | Initialize () |
static void | RegisterFactoryInternal (ObjectFactoryBase *) |
template<typename TFactory > | |
static void | RegisterInternalFactoryOnce () |
static void | ReHash () |
static void | UnRegisterAllFactories () |
static void | UnRegisterFactory (ObjectFactoryBase *) |
static bool | RegisterFactory (ObjectFactoryBase *, InsertionPositionEnum where=InsertionPositionEnum::INSERT_AT_BACK, vcl_size_t position=0) |
static void | SetStrictVersionChecking (bool) |
static void | StrictVersionCheckingOn () |
static void | StrictVersionCheckingOff () |
static bool | GetStrictVersionChecking () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
virtual std::list< LightObject::Pointer > | CreateAllObject (const char *itkclassname) |
virtual LightObject::Pointer | CreateObject (const char *itkclassname) |
ObjectFactoryBase () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
void | RegisterOverride (const char *classOverride, const char *subclass, const char *description, bool enableFlag, CreateObjectFunctionBase *createFunction) |
~ObjectFactoryBase () override | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Static Private Member Functions | |
static void | DeleteNonInternalFactory (ObjectFactoryBase *) |
static void | LoadDynamicFactories () |
static void | LoadLibrariesInPath (const char *) |
Private Attributes | |
unsigned long | m_LibraryDate {} |
void * | m_LibraryHandle {} |
std::string | m_LibraryPath {} |
const std::unique_ptr< OverrideMap > | m_OverrideMap |
Static Private Attributes | |
static ObjectFactoryBasePrivate * | m_PimplGlobals |
static void | SynchronizeObjectFactoryBase (void *objectFactoryBasePrivate) |
itkGetGlobalDeclarationMacro (ObjectFactoryBasePrivate, PimplGlobals) | |
Additional Inherited Members | |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::ObjectFactoryBase::ConstPointer = SmartPointer<const Self> |
Definition at line 68 of file itkObjectFactoryBase.h.
Definition at line 106 of file itkObjectFactoryBase.h.
Definition at line 67 of file itkObjectFactoryBase.h.
Standard class type aliases.
Definition at line 65 of file itkObjectFactoryBase.h.
Definition at line 66 of file itkObjectFactoryBase.h.
|
protected |
|
overrideprotected |
|
static |
Create and return all possible instances of the named itk object. Each loaded ObjectFactoryBase will be asked in the order the factory was in the ITK_AUTOLOAD_PATH. All created objects will be returned in the list.
|
protectedvirtual |
This method creates all the objects with the class override of itkclass name, which are provide by this object
|
static |
Create and return an instance of the named itk object. Each loaded ObjectFactoryBase will be asked in the order the factory was in the ITK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked.
CreateInstance
will have a reference count of 2, instead of 1. So in order to avoid memory leaks, one may need to call object->UnRegister()
. Referenced by itk::ObjectFactory< T >::Create(), and itk::TransformFactoryBase::RegisterTransform().
|
protectedvirtual |
This method is provided by sub-classes of ObjectFactoryBase. It should create the named itk object or return 0 if that object is not supported by the factory implementation.
|
staticprivate |
|
virtual |
Set all enable flags for the given class to 0. This will mean that the factory will stop producing class with the given name.
|
virtual |
Return a list of descriptions for class overrides.
|
virtual |
Return a list of classes that this factory overrides.
|
virtual |
Return a list of the names of classes that override classes.
|
pure virtual |
Return a descriptive string describing the factory.
Implemented in itk::GPUImageFactory, itk::SpatialObjectFactoryBase, itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUBinaryThresholdImageFilterFactory, itk::FFTDiscreteGaussianImageFilterFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Bruker2dseqImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::HDF5ImageIOFactory, itk::JPEGImageIOFactory, itk::JPEG2000ImageIOFactory, itk::LSMImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::MetaImageIOFactory, itk::MINCImageIOFactory, itk::MRCImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::TransformFactoryBase, itk::HDF5TransformIOFactory, itk::TxtTransformIOFactory, itk::MatlabTransformIOFactory, itk::VTKImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::GPUDemonsRegistrationFilterFactory, and itk::FileListVideoIOFactory.
|
virtual |
Get the Enable flag for the specific override of className.
|
virtual |
Return a list of enable flags.
|
pure virtual |
All sub-classes of ObjectFactoryBase should must return the version of ITK they were built with. This should be implemented with the macro ITK_SOURCE_VERSION and NOT a call to Version::GetITKSourceVersion. As the version needs to be compiled into the file as a string constant. This is critical to determine possible incompatible dynamic factory loads.
Implemented in itk::GPUImageFactory, itk::SpatialObjectFactoryBase, itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUBinaryThresholdImageFilterFactory, itk::FFTDiscreteGaussianImageFilterFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Bruker2dseqImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::HDF5ImageIOFactory, itk::JPEGImageIOFactory, itk::JPEG2000ImageIOFactory, itk::LSMImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::MetaImageIOFactory, itk::MINCImageIOFactory, itk::MRCImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::TransformFactoryBase, itk::HDF5TransformIOFactory, itk::TxtTransformIOFactory, itk::MatlabTransformIOFactory, itk::VTKImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::GPUDemonsRegistrationFilterFactory, and itk::FileListVideoIOFactory.
const char * itk::ObjectFactoryBase::GetLibraryPath | ( | ) |
This returns the path to a dynamically loaded factory.
|
overridevirtual |
Reimplemented from itk::Object.
Reimplemented in itk::GPUImageFactory, itk::SpatialObjectFactoryBase, itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUBinaryThresholdImageFilterFactory, itk::FFTDiscreteGaussianImageFilterFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Bruker2dseqImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::HDF5ImageIOFactory, itk::JPEGImageIOFactory, itk::JPEG2000ImageIOFactory, itk::LSMImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::MetaImageIOFactory, itk::MINCImageIOFactory, itk::MRCImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::TransformFactoryBase, itk::HDF5TransformIOFactory, itk::TxtTransformIOFactory, itk::MatlabTransformIOFactory, itk::VTKImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::GPUDemonsRegistrationFilterFactory, and itk::FileListVideoIOFactory.
|
static |
Return the list of all registered factories. This is NOT a copy, do not remove items from this list!
|
static |
Require the ITK version of this application to exactly match the ITK version used to compile a dynamic library. When this is set to true, if the versions do not match, an exception will be thrown. When this is false, and the versions do not match, only a warning message is printed out in the console, and the factory is still registered.
|
static |
Initialize the static members of ObjectFactoryBase.
|
private |
Set/Get the pointer to ObjectFactoryBasePrivate. No concurrent thread safe.
|
staticprivate |
Load dynamic factories from the ITK_AUTOLOAD_PATH
|
staticprivate |
Load all dynamic libraries in the given path
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::Object.
Reimplemented in itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::HDF5ImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::NiftiImageIOFactory, itk::SiemensVisionImageIOFactory, itk::HDF5TransformIOFactory, itk::TxtTransformIOFactory, and itk::MatlabTransformIOFactory.
|
static |
Register a factory so it can be used to create itk objects.
When InsertionPositionEnum::INSERT_AT_POSITION is selected, a third argument must be provided with the actual integer number of the intended position. The position number must be in the range [0, numberOfRegisteredFactories-1]. Usage should be any of the following: itk::ObjectFactoryBase::RegisterFactory( newFactory1 ); // at back itk::ObjectFactoryBase::RegisterFactory( newFactory2, InsertionPositionEnum::INSERT_AT_FRONT ); itk::ObjectFactoryBase::RegisterFactory( newFactory3, InsertionPositionEnum::INSERT_AT_BACK ); itk::ObjectFactoryBase::RegisterFactory( newFactory4, InsertionPositionEnum::INSERT_AT_POSITION, 5 ); If the position value is out of range, an exception will be thrown. Returns true if the factory was successfully registered. Returns false if factory is already loaded.
Referenced by itk::SpatialObjectFactoryBase::GetFactory(), itk::GPUImageFactory::RegisterOneFactory(), itk::GPUGradientAnisotropicDiffusionImageFilterFactory::RegisterOneFactory(), itk::GPUMeanImageFilterFactory::RegisterOneFactory(), itk::GPUBinaryThresholdImageFilterFactory::RegisterOneFactory(), itk::RawImageIOFactory< TPixel, VImageDimension >::RegisterOneFactory(), itk::VoxBoCUBImageIOFactory::RegisterOneFactory(), and itk::GPUDemonsRegistrationFilterFactory::RegisterOneFactory().
|
static |
Register a factory so it can be used to create itk objects. This method is intended to be called only for built-in default factories, not for loadable factories.
Factories that are registered with this method will be registered after ReHash.
Referenced by itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::RegisterOneFactory(), itk::FFTDiscreteGaussianImageFilterFactory::RegisterOneFactory(), itk::BioRadImageIOFactory::RegisterOneFactory(), itk::BMPImageIOFactory::RegisterOneFactory(), itk::Bruker2dseqImageIOFactory::RegisterOneFactory(), itk::GDCMImageIOFactory::RegisterOneFactory(), itk::GE4ImageIOFactory::RegisterOneFactory(), itk::GE5ImageIOFactory::RegisterOneFactory(), itk::GEAdwImageIOFactory::RegisterOneFactory(), itk::GiplImageIOFactory::RegisterOneFactory(), itk::HDF5ImageIOFactory::RegisterOneFactory(), itk::JPEGImageIOFactory::RegisterOneFactory(), itk::JPEG2000ImageIOFactory::RegisterOneFactory(), itk::LSMImageIOFactory::RegisterOneFactory(), itk::BYUMeshIOFactory::RegisterOneFactory(), itk::FreeSurferAsciiMeshIOFactory::RegisterOneFactory(), itk::FreeSurferBinaryMeshIOFactory::RegisterOneFactory(), itk::GiftiMeshIOFactory::RegisterOneFactory(), itk::OBJMeshIOFactory::RegisterOneFactory(), itk::OFFMeshIOFactory::RegisterOneFactory(), itk::VTKPolyDataMeshIOFactory::RegisterOneFactory(), itk::MetaImageIOFactory::RegisterOneFactory(), itk::MINCImageIOFactory::RegisterOneFactory(), itk::MRCImageIOFactory::RegisterOneFactory(), itk::NiftiImageIOFactory::RegisterOneFactory(), itk::NrrdImageIOFactory::RegisterOneFactory(), itk::PNGImageIOFactory::RegisterOneFactory(), itk::SiemensVisionImageIOFactory::RegisterOneFactory(), itk::StimulateImageIOFactory::RegisterOneFactory(), itk::TIFFImageIOFactory::RegisterOneFactory(), itk::HDF5TransformIOFactory::RegisterOneFactory(), itk::TxtTransformIOFactory::RegisterOneFactory(), itk::MatlabTransformIOFactory::RegisterOneFactory(), itk::VTKImageIOFactory::RegisterOneFactory(), and itk::FileListVideoIOFactory::RegisterOneFactory().
|
inlinestatic |
Registers the specified internal factory only once, even when RegisterInternalFactoryOnce<TFactory>()
is called multiple times (possibly even by multiple threads) for the very same factory.
Definition at line 217 of file itkObjectFactoryBase.h.
References New().
|
protected |
Register object creation information with the factory.
Referenced by itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::OverrideFFTImageFilterType(), itk::FFTDiscreteGaussianImageFilterFactory::OverrideSuperclassType(), and itk::TransformFactoryBase::RegisterTransform().
|
static |
Re-check the ITK_AUTOLOAD_PATH for new factory libraries. This calls UnRegisterAll before re-loading.
|
virtual |
Set the Enable flag for the specific override of className.
|
static |
Require the ITK version of this application to exactly match the ITK version used to compile a dynamic library. When this is set to true, if the versions do not match, an exception will be thrown. When this is false, and the versions do not match, only a warning message is printed out in the console, and the factory is still registered.
|
static |
Require the ITK version of this application to exactly match the ITK version used to compile a dynamic library. When this is set to true, if the versions do not match, an exception will be thrown. When this is false, and the versions do not match, only a warning message is printed out in the console, and the factory is still registered.
|
static |
Require the ITK version of this application to exactly match the ITK version used to compile a dynamic library. When this is set to true, if the versions do not match, an exception will be thrown. When this is false, and the versions do not match, only a warning message is printed out in the console, and the factory is still registered.
|
staticprivate |
Set/Get the pointer to ObjectFactoryBasePrivate. No concurrent thread safe.
|
static |
Unregister all factories.
|
static |
Remove a factory from the list of registered factories.
|
private |
Definition at line 288 of file itkObjectFactoryBase.h.
|
private |
Member variables for a factory set by the base class at load or register time
Definition at line 287 of file itkObjectFactoryBase.h.
|
private |
Definition at line 289 of file itkObjectFactoryBase.h.
|
private |
Definition at line 272 of file itkObjectFactoryBase.h.
|
staticprivate |
Definition at line 291 of file itkObjectFactoryBase.h.