1 /*=========================================================================
4 Module: $RCSfile: bbtkFactory.h,v $
6 Date: $Date: 2008/02/05 11:39:32 $
7 Version: $Revision: 1.4 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See doc/license.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 *\brief Class bbtk::Factory : can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded.
24 *\brief Can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded.
29 #ifndef __bbtkFactory_h__
30 #define __bbtkFactory_h__
32 //#include "bbtkBlackBox.h"
33 #include "bbtkPackage.h"
34 #include "bbtkDynamicLibraryHandling.h"
38 class BBTK_EXPORT Factory
46 void LoadPackage( const std::string& name,
47 bool use_configuration_file = true,
48 bool verbose = false );
49 void UnLoadPackage( const std::string& name );
50 void PrintPackages(bool details = true, bool adaptors = false) const;
51 void HelpPackage(const std::string& name, bool adaptors = false) const;
52 void HelpBlackBox(const std::string& name, bool full=true) const;
53 void ShowGraphTypes(const std::string& name) const;
54 void InsertPackage( Package* );
55 void RemovePackage( Package* );
57 const Package* GetPackage(const std::string& name) const;
58 Package* GetPackage(const std::string& name);
60 BlackBox* NewBlackBox(const std::string& type,
61 const std::string& name) const;
63 BlackBox* NewAdaptor(TypeInfo typein,
65 const std::string& name) const;
67 Connection* NewConnection(BlackBox* from,
68 const std::string& output,
70 const std::string& input) const;
72 void WriteDotFilePackagesList(FILE *ff);
83 void CreateHtmlIndex(IndexEntryType type, const std::string& filename);
87 bool DoLoadPackage(std::string libname,
92 /// The structure storing info on a package
100 /// The pointer on the package
102 /// The handler of the dynamic library
103 DynamicLibraryHandler mDynamicLibraryHandler;
105 /// The type of map of packages
106 typedef std::map< std::string, PackageInfoType > PackageMapType;
107 /// The map of packages
108 PackageMapType mPackageMap;
110 void CloseAllPackages();
111 void ClosePackage(PackageMapType::iterator& i);
117 /// SYSTEM METHOD : Global method returning the global factory object pointer
118 inline Factory*& GlobalFactoryPointer()
120 static Factory* f = 0;
124 /// SYSTEM METHOD : Global method returning the global factory object
125 inline Factory* GetGlobalFactory()
127 if (!GlobalFactoryPointer())
129 GlobalFactoryPointer() = new Factory;
131 return GlobalFactoryPointer();
134 /// SYSTEM METHOD : Deletes the global factory pointer
135 inline void DeleteGlobalFactory()
137 if (GlobalFactoryPointer())
139 delete GlobalFactoryPointer();
143 inline void LoadPackage( const std::string& name,
144 bool use_configuration_file = true, bool verbose = false )
146 GetGlobalFactory()->LoadPackage(name,use_configuration_file, verbose);
149 inline void UnLoadPackage( const std::string& name )
151 GetGlobalFactory()->UnLoadPackage(name);
154 inline void PrintPackages(bool details = true, bool adaptors = false)
156 GetGlobalFactory()->PrintPackages(details,adaptors);
159 inline void HelpPackage(const std::string& name, bool adaptors = false)
161 GetGlobalFactory()->HelpPackage(name,adaptors);
164 inline void HelpBlackBox(const std::string& name, bool full=true)
166 GetGlobalFactory()->HelpBlackBox(name,full);
170 inline void ShowGraphTypes(const std::string& name)
172 GetGlobalFactory()->ShowGraphTypes(name);
175 inline void InsertPackage( Package* p)
177 GetGlobalFactory()->InsertPackage(p);
180 inline void RemovePackage( Package* p)
182 GetGlobalFactory()->RemovePackage(p);
185 inline const Package* GetPackage(const std::string& name)
187 return GetGlobalFactory()->GetPackage(name);
190 inline BlackBox* NewBlackBox(const std::string& type,
191 const std::string& name)
193 return GetGlobalFactory()->NewBlackBox(type,name);
196 inline BlackBox* NewAdaptor(TypeInfo typein,
198 const std::string& name)
200 return GetGlobalFactory()->NewAdaptor(typein,typeout,name);
203 inline Connection* NewConnection(BlackBox* from,
204 const std::string& output,
206 const std::string& input)
208 return GetGlobalFactory()->NewConnection(from,output,to,input);
211 inline void WriteDotFilePackagesList(FILE *ff)
213 GetGlobalFactory()->WriteDotFilePackagesList(ff);