albaObjectFactory.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaObjectFactory
 Authors: Based on itkObjectFactory (www.itk.org), adapted by Marco Petrone
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef __albaObjectFactory_h
#define __albaObjectFactory_h
 
#include "albaReferenceCounted.h"
#include "albaSmartPointer.h"
#include "albaString.h"
 
#include <vector>
#include <list>
#include <map>
#include <string>
 
#define albaPlugObjectMacro(node_type,typeName) \
  RegisterNewObject(node_type::GetStaticTypeName(), typeName, node_type::NewObject);
 
typedef albaObject* (*albaCreateObjectFunction)();
 
//------------------------------------------------------------------------------
// Forward declarations
//------------------------------------------------------------------------------
class albaIndent;
 
class ALBA_EXPORT albaObjectFactory : public albaReferenceCounted
{
public:    
  albaAbstractTypeMacro(albaObjectFactory, albaReferenceCounted);
 
  static albaObject *CreateInstance(const char* classname);
 
  static std::list<albaObject *>
  CreateAllInstance(const char* classname);
  
  static void ReHash(); 
 
  static void RegisterFactory(albaObjectFactory* );
 
  static void UnRegisterFactory(albaObjectFactory*);
 
  static void UnRegisterAllFactories();
  
  static std::list<albaObjectFactory*> GetRegisteredFactories();
 
  virtual const char* GetDescription(void) const = 0;
 
  virtual std::list<std::string> GetClassOverrideNames();
 
  virtual std::list<std::string> GetClassOverrideWithNames();
 
  virtual std::list<std::string> GetClassOverrideTypeNames();
 
  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();
 
   std::string GetObjectTypeName(const char* classname);
 
 
  void RegisterNewObject(const char* ObjectName, const char* typeName, albaCreateObjectFunction createFunction,albaReferenceCounted *args=NULL);
 
  void RegisterOverride(const char* classOverride,
      const char* overrideClassName,
      const char* typeName,
      bool enableFlag,
      albaCreateObjectFunction createFunction,
      albaReferenceCounted *args=NULL);
 
  albaReferenceCounted *GetArgs(const char *type_name);
 
  struct mmuOverrideInformation
  {
    std::string m_TypeName;
    std::string m_OverrideWithName;
    bool m_EnabledFlag;
    albaCreateObjectFunction m_CreateObject;
    albaAutoPointer<albaReferenceCounted> m_Args;
  };
  
  virtual void Print(std::ostream& os, const int indent=0) const;
 
  albaObjectFactory();
  virtual ~albaObjectFactory();
 
 
protected:
    
  virtual albaObject *CreateObject(const char* classname );
      
  albaReferenceCounted *GetFactoryArgs(const char *type_name);
 
  //------------------------------------------------------------------------------
  typedef std::multimap<std::string, mmuOverrideInformation> mmuOverRideMap;
 
  mmuOverRideMap* m_OverrideMap;
 
private:
  albaObjectFactory(const albaObjectFactory&); //purposely not implemented
  void operator=(const albaObjectFactory&); //purposely not implemented
 
  static void Initialize();
 
  static void RegisterDefaults();
 
  static void LoadDynamicFactories();
 
  static void LoadLibrariesInPath( const char*);
  
  static std::list<albaObjectFactory*>* m_RegisteredFactories; 
  
  void* m_LibraryHandle;
  unsigned long m_LibraryDate;
  std::string m_LibraryPath;
};
 
#endif