![]() |
ITK
4.13.0
Insight Segmentation and Registration 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 registerd 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 overide the creation of any object in ITK.
Definition at line 60 of file itkObjectFactoryBase.h.
Classes | |
class | OverrideInformation |
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
enum | InsertionPositionType { INSERT_AT_FRONT, INSERT_AT_BACK, INSERT_AT_POSITION } |
typedef SmartPointer< Self > | Pointer |
typedef ObjectFactoryBase | Self |
typedef Object | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
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 (void) const =0 |
virtual bool | GetEnableFlag (const char *className, const char *subclassName) |
virtual std::list< bool > | GetEnableFlags () |
virtual const char * | GetITKSourceVersion (void) const =0 |
const char * | GetLibraryPath () |
virtual const char * | GetNameOfClass () const |
virtual void | SetEnableFlag (bool flag, const char *className, const char *subclassName) |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual 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 |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) override |
virtual void | UnRegister () const noexceptoverride |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
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 | RegisterFactoryInternal (ObjectFactoryBase *) |
static void | ReHash () |
static void | UnRegisterAllFactories () |
static void | UnRegisterFactory (ObjectFactoryBase *) |
static bool | RegisterFactory (ObjectFactoryBase *, InsertionPositionType where=INSERT_AT_BACK, vcl_size_t position=0) |
static void | SetStrictVersionChecking (bool) |
static void | StrictVersionCheckingOn () |
static void | StrictVersionCheckingOff () |
static bool | GetStrictVersionChecking () |
static ObjectFactoryBasePrivate * | GetObjectFactoryBase () |
static void | SynchronizeObjectFactoryBase (ObjectFactoryBasePrivate *objectFactoryBasePrivate) |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
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 () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
void | RegisterOverride (const char *classOverride, const char *overrideClassName, const char *description, bool enableFlag, CreateObjectFunctionBase *createFunction) |
virtual | ~ObjectFactoryBase () override |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () override |
![]() | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (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 | Initialize () |
static void | InitializeFactoryList () |
static void | LoadDynamicFactories () |
static void | LoadLibrariesInPath (const char *) |
static void | RegisterInternal () |
Private Attributes | |
unsigned long | m_LibraryDate |
void * | m_LibraryHandle |
std::string | m_LibraryPath |
OverRideMap * | m_OverrideMap |
Static Private Attributes | |
static ObjectFactoryBasePrivate * | m_ObjectFactoryBasePrivate |
static bool | m_StrictVersionChecking |
Additional Inherited Members | |
![]() | |
AtomicInt< int > | m_ReferenceCount |
typedef SmartPointer< const Self > itk::ObjectFactoryBase::ConstPointer |
Definition at line 68 of file itkObjectFactoryBase.h.
typedef SmartPointer< Self > itk::ObjectFactoryBase::Pointer |
Definition at line 67 of file itkObjectFactoryBase.h.
Standard class typedefs.
Definition at line 65 of file itkObjectFactoryBase.h.
Definition at line 66 of file itkObjectFactoryBase.h.
Position at which the new factory will be registered in the internal factory container.
Enumerator | |
---|---|
INSERT_AT_FRONT | |
INSERT_AT_BACK | |
INSERT_AT_POSITION |
Definition at line 102 of file itkObjectFactoryBase.h.
|
protected |
|
overrideprotectedvirtual |
|
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 overide 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.
Referenced by itk::ObjectFactory< T >::Create().
|
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::RawImageIOFactory< TPixel, VImageDimension >, itk::GPUDemonsRegistrationFilterFactory, itk::GPUBinaryThresholdImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::MRCImageIOFactory, itk::FEMFactoryBase, itk::JPEG2000ImageIOFactory, itk::SpatialObjectFactoryBase, itk::VTKImageIOFactory, itk::TransformFactoryBase, itk::BioRadImageIOFactory, itk::LSMImageIOFactory, itk::StimulateImageIOFactory, itk::MINCImageIOFactory, itk::Bruker2dseqImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::DCMTKTransformIOFactory, itk::HDF5ImageIOFactory, itk::AnalyzeObjectLabelMapImageIOFactory, itk::STLMeshIOFactory, itk::JPEGImageIOFactory, itk::NiftiImageIOFactory, itk::PNGImageIOFactory, itk::TIFFImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::SiemensVisionImageIOFactory, itk::HDF5TransformIOFactory, itk::MatlabTransformIOFactory, itk::FileListVideoIOFactory, itk::OpenCVVideoIOFactory, itk::MGHImageIOFactory, itk::BMPImageIOFactory, itk::GDCMImageIOFactory, itk::GiplImageIOFactory, itk::MetaImageIOFactory, itk::NrrdImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::DCMTKImageIOFactory, itk::TxtTransformIOFactory, itk::VXLVideoIOFactory, and itk::SCIFIOImageIOFactory.
|
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::GPUDemonsRegistrationFilterFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::GPUBinaryThresholdImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::MRCImageIOFactory, itk::FEMFactoryBase, itk::JPEG2000ImageIOFactory, itk::SpatialObjectFactoryBase, itk::VTKImageIOFactory, itk::TransformFactoryBase, itk::BioRadImageIOFactory, itk::LSMImageIOFactory, itk::StimulateImageIOFactory, itk::MINCImageIOFactory, itk::Bruker2dseqImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::DCMTKTransformIOFactory, itk::HDF5ImageIOFactory, itk::AnalyzeObjectLabelMapImageIOFactory, itk::STLMeshIOFactory, itk::JPEGImageIOFactory, itk::NiftiImageIOFactory, itk::PNGImageIOFactory, itk::TIFFImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::SiemensVisionImageIOFactory, itk::HDF5TransformIOFactory, itk::MatlabTransformIOFactory, itk::FileListVideoIOFactory, itk::OpenCVVideoIOFactory, itk::MGHImageIOFactory, itk::BMPImageIOFactory, itk::GDCMImageIOFactory, itk::GiplImageIOFactory, itk::MetaImageIOFactory, itk::NrrdImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::DCMTKImageIOFactory, itk::TxtTransformIOFactory, itk::VXLVideoIOFactory, and itk::SCIFIOImageIOFactory.
const char* itk::ObjectFactoryBase::GetLibraryPath | ( | ) |
This returns the path to a dynamically loaded factory.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::Object.
Reimplemented in itk::GPUImageFactory, itk::GPUDemonsRegistrationFilterFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::GPUBinaryThresholdImageFilterFactory, itk::GPUMeanImageFilterFactory, itk::GPUGradientAnisotropicDiffusionImageFilterFactory, itk::MRCImageIOFactory, itk::JPEG2000ImageIOFactory, itk::VTKImageIOFactory, itk::BioRadImageIOFactory, itk::LSMImageIOFactory, itk::StimulateImageIOFactory, itk::MINCImageIOFactory, itk::FEMFactoryBase, itk::SpatialObjectFactoryBase, itk::TransformFactoryBase, itk::Bruker2dseqImageIOFactory, itk::VoxBoCUBImageIOFactory, itk::DCMTKTransformIOFactory, itk::HDF5ImageIOFactory, itk::AnalyzeObjectLabelMapImageIOFactory, itk::JPEGImageIOFactory, itk::PNGImageIOFactory, itk::TIFFImageIOFactory, itk::STLMeshIOFactory, itk::NiftiImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::SiemensVisionImageIOFactory, itk::HDF5TransformIOFactory, itk::MatlabTransformIOFactory, itk::FileListVideoIOFactory, itk::OpenCVVideoIOFactory, itk::MGHImageIOFactory, itk::BMPImageIOFactory, itk::GDCMImageIOFactory, itk::GiplImageIOFactory, itk::MetaImageIOFactory, itk::NrrdImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::DCMTKImageIOFactory, itk::TxtTransformIOFactory, itk::VXLVideoIOFactory, and itk::SCIFIOImageIOFactory.
|
static |
Set/Get the pointer to ObjectFactoryBasePrivate. Note that these functions are not part of the public API and should not be used outside of ITK. They are an implementation detail and will be removed in the future. Also note that SetObjectFactoryBasePrivate is not concurrent thread safe.
|
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.
|
staticprivate |
Initialize the static members of ObjectFactoryBase. RegisterInternal() and InitializeFactoryList() are called here.
|
staticprivate |
Initialize the static list of Factories.
|
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::DCMTKTransformIOFactory, itk::STLMeshIOFactory, itk::HDF5ImageIOFactory, itk::AnalyzeObjectLabelMapImageIOFactory, itk::MatlabTransformIOFactory, itk::NiftiImageIOFactory, itk::BYUMeshIOFactory, itk::FreeSurferAsciiMeshIOFactory, itk::FreeSurferBinaryMeshIOFactory, itk::GiftiMeshIOFactory, itk::OBJMeshIOFactory, itk::OFFMeshIOFactory, itk::VTKPolyDataMeshIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::SiemensVisionImageIOFactory, itk::HDF5TransformIOFactory, itk::MGHImageIOFactory, and itk::TxtTransformIOFactory.
|
static |
Register a factory so it can be used to create itk objects.
When 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, INSERT_AT_FRONT ); itk::ObjectFactoryBase::RegisterFactory( newFactory3, INSERT_AT_BACK ); itk::ObjectFactoryBase::RegisterFactory( newFactory4, 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::FEMFactoryBase::GetFactory(), ProcessArgumentsAndRegisterBuiltInFactories(), itk::AnalyzeObjectLabelMapImageIOFactory::RegisterOneFactory(), itk::STLMeshIOFactory::RegisterOneFactory(), itk::VoxBoCUBImageIOFactory::RegisterOneFactory(), itk::JPEG2000ImageIOFactory::RegisterOneFactory(), itk::GPUGradientAnisotropicDiffusionImageFilterFactory::RegisterOneFactory(), itk::GPUMeanImageFilterFactory::RegisterOneFactory(), itk::GPUBinaryThresholdImageFilterFactory::RegisterOneFactory(), itk::RawImageIOFactory< TPixel, VImageDimension >::RegisterOneFactory(), itk::GPUDemonsRegistrationFilterFactory::RegisterOneFactory(), itk::GPUImageFactory::RegisterOneFactory(), and RegisterRequiredFactories().
|
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 regisistered after ReHash.
Referenced by itk::SCIFIOImageIOFactory::RegisterOneFactory(), itk::BYUMeshIOFactory::RegisterOneFactory(), itk::FreeSurferAsciiMeshIOFactory::RegisterOneFactory(), itk::TxtTransformIOFactory::RegisterOneFactory(), itk::FreeSurferBinaryMeshIOFactory::RegisterOneFactory(), itk::VTKPolyDataMeshIOFactory::RegisterOneFactory(), itk::VXLVideoIOFactory::RegisterOneFactory(), itk::DCMTKImageIOFactory::RegisterOneFactory(), itk::GDCMImageIOFactory::RegisterOneFactory(), itk::MetaImageIOFactory::RegisterOneFactory(), itk::BMPImageIOFactory::RegisterOneFactory(), itk::NrrdImageIOFactory::RegisterOneFactory(), itk::OBJMeshIOFactory::RegisterOneFactory(), itk::GiftiMeshIOFactory::RegisterOneFactory(), itk::OFFMeshIOFactory::RegisterOneFactory(), itk::GiplImageIOFactory::RegisterOneFactory(), itk::SiemensVisionImageIOFactory::RegisterOneFactory(), itk::MGHImageIOFactory::RegisterOneFactory(), itk::HDF5TransformIOFactory::RegisterOneFactory(), itk::FileListVideoIOFactory::RegisterOneFactory(), itk::MatlabTransformIOFactory::RegisterOneFactory(), itk::GE4ImageIOFactory::RegisterOneFactory(), itk::NiftiImageIOFactory::RegisterOneFactory(), itk::OpenCVVideoIOFactory::RegisterOneFactory(), itk::GE5ImageIOFactory::RegisterOneFactory(), itk::GEAdwImageIOFactory::RegisterOneFactory(), itk::JPEGImageIOFactory::RegisterOneFactory(), itk::PNGImageIOFactory::RegisterOneFactory(), itk::TIFFImageIOFactory::RegisterOneFactory(), itk::HDF5ImageIOFactory::RegisterOneFactory(), itk::DCMTKTransformIOFactory::RegisterOneFactory(), itk::Bruker2dseqImageIOFactory::RegisterOneFactory(), itk::StimulateImageIOFactory::RegisterOneFactory(), itk::LSMImageIOFactory::RegisterOneFactory(), itk::VTKImageIOFactory::RegisterOneFactory(), itk::BioRadImageIOFactory::RegisterOneFactory(), itk::MINCImageIOFactory::RegisterOneFactory(), and itk::MRCImageIOFactory::RegisterOneFactory().
|
staticprivate |
Register default factories which are not loaded at run time.
|
protected |
Register object creation information with the factory.
Referenced by itk::SpatialObjectFactoryBase::RegisterSpatialObject().
|
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.
|
static |
Set/Get the pointer to ObjectFactoryBasePrivate. Note that these functions are not part of the public API and should not be used outside of ITK. They are an implementation detail and will be removed in the future. Also note that SetObjectFactoryBasePrivate is not concurrent thread safe.
|
static |
Unregister all factories.
|
static |
Remove a factory from the list of registered factories.
|
private |
Definition at line 261 of file itkObjectFactoryBase.h.
|
private |
Member variables for a factory set by the base class at load or register time
Definition at line 260 of file itkObjectFactoryBase.h.
|
private |
Definition at line 262 of file itkObjectFactoryBase.h.
|
staticprivate |
Definition at line 267 of file itkObjectFactoryBase.h.
|
private |
Definition at line 236 of file itkObjectFactoryBase.h.
|
staticprivate |
Definition at line 264 of file itkObjectFactoryBase.h.