ITK: itk::ObjectFactoryBase Class Reference

typedef SmartPointer<const Self> itk::ObjectFactoryBase::ConstPointer

Reimplemented from itk::Object.

Definition at line 57 of file itkObjectFactoryBase.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef SmartPointer<Self> itk::ObjectFactoryBase::Pointer

Reimplemented from itk::Object.

Definition at line 56 of file itkObjectFactoryBase.h.

typedef ObjectFactoryBase itk::ObjectFactoryBase::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 54 of file itkObjectFactoryBase.h.

typedef Object itk::ObjectFactoryBase::Superclass

Reimplemented from itk::Object.

Definition at line 55 of file itkObjectFactoryBase.h.

itk::ObjectFactoryBase::ObjectFactoryBase ( ) [protected]

virtual itk::ObjectFactoryBase::~ObjectFactoryBase ( ) [protected, virtual]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

static std::list<LightObject::Pointer> itk::ObjectFactoryBase::CreateAllInstance ( const char * itkclassname ) [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.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

static LightObject::Pointer itk::ObjectFactoryBase::CreateInstance ( const char * itkclassname ) [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().

virtual LightObject::Pointer itk::ObjectFactoryBase::CreateObject ( const char * itkclassname ) [protected, virtual]

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.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ObjectFactoryBase::Disable ( const char * className ) [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 std::list<std::string> itk::ObjectFactoryBase::GetClassOverrideDescriptions ( ) [virtual]

Return a list of descriptions for class overrides.

virtual std::list<std::string> itk::ObjectFactoryBase::GetClassOverrideNames ( ) [virtual]

Return a list of classes that this factory overrides.

virtual std::list<std::string> itk::ObjectFactoryBase::GetClassOverrideWithNames ( ) [virtual]

Return a list of the names of classes that override classes.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

virtual const char* itk::ObjectFactoryBase::GetDescription ( void ) const [pure virtual]

Return a descriptive string describing the factory.

virtual bool itk::ObjectFactoryBase::GetEnableFlag	(	const char *	className,
		const char *	subclassName
	)			`[virtual]`

Get the Enable flag for the specific override of className.

virtual std::list<bool> itk::ObjectFactoryBase::GetEnableFlags ( ) [virtual]

Return a list of enable flags.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

virtual const char* itk::ObjectFactoryBase::GetITKSourceVersion ( void ) const [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.

const char* itk::ObjectFactoryBase::GetLibraryPath ( )

This returns the path to a dynamically loaded factory.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

virtual const char* itk::ObjectFactoryBase::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

static std::list<ObjectFactoryBase*> itk::ObjectFactoryBase::GetRegisteredFactories ( ) [static]

Return the list of all registered factories. This is NOT a copy, do not remove items from this list!

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Object::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

virtual void itk::ObjectFactoryBase::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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::AnalyzeImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::NiftiImageIOFactory, itk::SiemensVisionImageIOFactory, itk::MatlabTransformIOFactory, and itk::TxtTransformIOFactory.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

static void itk::ObjectFactoryBase::RegisterFactory ( ObjectFactoryBase * ) [static]

Register a factory so it can be used to create itk objects.

void itk::ObjectFactoryBase::RegisterOverride	(	const char *	classOverride,
		const char *	overrideClassName,
		const char *	description,
		bool	enableFlag,
		CreateObjectFunctionBase *	createFunction
	)			`[protected]`

Register object creation information with the factory.

Referenced by itk::SpatialObjectFactoryBase::RegisterSpatialObject().

static void itk::ObjectFactoryBase::ReHash ( ) [static]

Re-check the ITK_AUTOLOAD_PATH for new factory libraries. This calls UnRegisterAll before re-loading.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

virtual void itk::ObjectFactoryBase::SetEnableFlag	(	bool	flag,
		const char *	className,
		const char *	subclassName
	)			`[virtual]`

Set the Enable flag for the specific override of className.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

static void itk::ObjectFactoryBase::UnRegisterAllFactories ( ) [static]

Unregister all factories.

static void itk::ObjectFactoryBase::UnRegisterFactory ( ObjectFactoryBase * ) [static]

Remove a factory from the list of registered factories.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef ObjectFactoryBase	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	Disable (const char *className)
virtual std::list< std::string >	GetClassOverrideDescriptions ()
virtual std::list< std::string >	GetClassOverrideNames ()
virtual std::list< std::string >	GetClassOverrideWithNames ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
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 ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetEnableFlag (bool flag, const char className, const char subclassName)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
Static Public Member Functions
static void	BreakOnError ()
static std::list< LightObject::Pointer >	CreateAllInstance (const char *itkclassname)
static LightObject::Pointer	CreateInstance (const char *itkclassname)
static std::list< ObjectFactoryBase * >	GetRegisteredFactories ()
static Pointer	New ()
static void	RegisterFactory (ObjectFactoryBase *)
static void	ReHash ()
static void	UnRegisterAllFactories ()
static void	UnRegisterFactory (ObjectFactoryBase *)

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual LightObject::Pointer	CreateObject (const char *itkclassname)
	ObjectFactoryBase ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	RegisterOverride (const char classOverride, const char overrideClassName, const char description, bool enableFlag, CreateObjectFunctionBase createFunction)
virtual	~ObjectFactoryBase ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Classes
class	OverrideInformation
	Internal implementation class for ObjectFactorBase. More...

itk::ObjectFactoryBase Class Reference
[ITK System Objects]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ObjectFactoryBase Class Reference [ITK System Objects]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ObjectFactoryBase Class Reference
[ITK System Objects]