itkObjectFactoryBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkObjectFactoryBase.h,v $
  Language:  C++
  Date:      $Date: 2009-12-23 14:55:37 $
  Version:   $Revision: 1.38 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkObjectFactoryBase_h
#define __itkObjectFactoryBase_h

#include "itkObject.h"
#include "itkCreateObjectFunction.h"
#include <list>
#include <vector>

namespace itk
{
class OverRideMap;

class ITKCommon_EXPORT ObjectFactoryBase : public Object
{
public:  
  typedef ObjectFactoryBase        Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;
  
  itkTypeMacro(ObjectFactoryBase, Object);

  static LightObject::Pointer CreateInstance(const char* itkclassname);

  static std::list<LightObject::Pointer>
  CreateAllInstance(const char* itkclassname);
  
  static void ReHash(); 

  static void RegisterFactory(ObjectFactoryBase* );

  static void UnRegisterFactory(ObjectFactoryBase*);

  static void UnRegisterAllFactories();
  
  static std::list<ObjectFactoryBase*> GetRegisteredFactories();

  virtual const char* GetITKSourceVersion(void) const = 0;

  virtual const char* GetDescription(void) const = 0;

  virtual std::list<std::string> GetClassOverrideNames();

  virtual std::list<std::string> GetClassOverrideWithNames();

  virtual std::list<std::string> GetClassOverrideDescriptions();

  virtual std::list<bool> GetEnableFlags();

  virtual void SetEnableFlag(bool flag,
           const char* className,
           const char* subclassName);

  virtual bool GetEnableFlag(const char* className,
                             const char* subclassName);

  virtual void Disable(const char* className);
  
  const char* GetLibraryPath();

  struct OverrideInformation
    {
    std::string m_Description;
    std::string m_OverrideWithName;
    bool m_EnabledFlag;
    CreateObjectFunctionBase::Pointer m_CreateObject;
    };

protected:
  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 LightObject::Pointer CreateObject(const char* itkclassname );

  virtual std::list<LightObject::Pointer>
  CreateAllObject(const char* itkclassname);  

  ObjectFactoryBase();
  virtual ~ObjectFactoryBase();

private:
  OverRideMap* m_OverrideMap;

  ObjectFactoryBase(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  static void Initialize();

  static void RegisterDefaults();

  static void LoadDynamicFactories();

  static void LoadLibrariesInPath( const char*);
  
  static std::list<ObjectFactoryBase*>* m_RegisteredFactories; 
  
  void*         m_LibraryHandle;
  unsigned long m_LibraryDate;
  std::string   m_LibraryPath;
};

} // end namespace itk

#endif