X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkFactory.h;h=8c80ec78da1043d48fe1d645e23b2dea5c109d4d;hb=87efce51877a540d943b1aa26307994b38bba55b;hp=9b2aab1949b1dca36878bcabc87a498ab6e7d7fc;hpb=b0f29a1286e2f997c5e4bc93b047c35a8b4e14f4;p=bbtk.git diff --git a/kernel/src/bbtkFactory.h b/kernel/src/bbtkFactory.h index 9b2aab1..8c80ec7 100644 --- a/kernel/src/bbtkFactory.h +++ b/kernel/src/bbtkFactory.h @@ -1,20 +1,40 @@ +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # This software is governed by the CeCILL-B license under French law and + # abiding by the rules of distribution of free software. You can use, + # modify and/ or redistribute the software under the terms of the CeCILL-B + # license as circulated by CEA, CNRS and INRIA at the following URL + # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html + # or in the file LICENSE.txt. + # + # As a counterpart to the access to the source code and rights to copy, + # modify and redistribute granted by the license, users are provided only + # with a limited warranty and the software's author, the holder of the + # economic rights, and the successive licensors have only limited + # liability. + # + # The fact that you are presently reading this means that you have had + # knowledge of the CeCILL-B license and that you accept its terms. + # ------------------------------------------------------------------------ */ + + /*========================================================================= - Program: bbtk Module: $RCSfile: bbtkFactory.h,v $ Language: C++ - Date: $Date: 2008/02/05 11:39:32 $ - Version: $Revision: 1.4 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See doc/license.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html 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. - + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.19 $ =========================================================================*/ + + + /** *\file *\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. @@ -29,84 +49,133 @@ #ifndef __bbtkFactory_h__ #define __bbtkFactory_h__ -//#include "bbtkBlackBox.h" #include "bbtkPackage.h" -#include "bbtkDynamicLibraryHandling.h" namespace bbtk { - class BBTK_EXPORT Factory - { - - public: - Factory(); - ~Factory(); + class Executer; + BBTK_FORWARD_DECLARE_POINTER(Executer); - void LoadPackage( const std::string& name, - bool use_configuration_file = true, - bool verbose = false ); + class BBTK_EXPORT Factory : public Object + { + BBTK_OBJECT_INTERFACE(Factory); + typedef Object Superclass; + public: + static Pointer New(); + + // @name Packages management + //@{ + /// Pushes back the names of the Package s which are in the Factory + void GetPackagesList(std::vector&); + /// Loads a dynamic library which contains a Package + void LoadPackage( const std::string& name ); + /// Unloads a Package which was loaded from a dynamic library void UnLoadPackage( const std::string& name ); - void PrintPackages(bool details = true, bool adaptors = false) const; - void HelpPackage(const std::string& name, bool adaptors = false) const; - void HelpBlackBox(const std::string& name, bool full=true) const; + /// Inserts a Package in the Factory + void InsertPackage( Package::Pointer ); + /// Removess a Package from the Factory + void RemovePackage( Package::Pointer ); + /// Returns the pointer on a Package provided by name + Package::Pointer GetPackage(const std::string& name) const; + /// The type of map of packages + typedef std::map< std::string, Package::Pointer > PackageMapType; + /// Returns the map of Packages + const PackageMapType& GetPackageMap() const { return mPackageMap; } + //@} + + // @name Methods which print help + //@{ + /// Prints the list of Package + void PrintHelpListPackages(bool details = true, + bool adaptors = false) const; + /// Prints help on a particular Package + void PrintHelpPackage(const std::string& name, + bool adaptors = false) const; + /// Prints help on a BlackBoxDescriptor + void PrintHelpDescriptor(const std::string& name, + std::string& package, + bool full=true ) const; + void ShowGraphTypes(const std::string& name) const; - void InsertPackage( Package* ); - void RemovePackage( Package* ); + // @} - const Package* GetPackage(const std::string& name) const; - Package* GetPackage(const std::string& name); - - BlackBox* NewBlackBox(const std::string& type, + + /// @name Object creation methods + //@{ + BlackBox::Pointer NewBlackBox(const std::string& type, const std::string& name) const; - BlackBox* NewAdaptor(TypeInfo typein, - TypeInfo typeout, + BlackBox::Pointer NewAdaptor(const DataInfo& typein, + const DataInfo& typeout, const std::string& name) const; - - Connection* NewConnection(BlackBox* from, - const std::string& output, - BlackBox* to, - const std::string& input) const; + BlackBox::Pointer NewWidgetAdaptor(const DataInfo& typein, + const DataInfo& typeout, + const std::string& name) const; + + Connection::Pointer NewConnection(BlackBox::Pointer from, + const std::string& output, + BlackBox::Pointer to, + const std::string& input) const; + //@} + + /// @name Package inspection methods + /// Allow to test if an Adaptor is present in the packages WITHOUT instanciating it + //@{ + bool FindAdaptor(const DataInfo& typein, + const DataInfo& typeout, + std::string& adaptor) const; + + bool FindWidgetAdaptor(const DataInfo& typein, + const DataInfo& typeout, + std::string& adaptor) const; + + bool FindWidgetAdaptor2(const DataInfo& typein, + const DataInfo& typeout, + std::string& widget, + std::string& adaptor) const; + //@} + void WriteDotFilePackagesList(FILE *ff); + /// Releases all the packages of the Factory void Reset(); + void Check() const; + typedef enum { Packages, Categories, - Initials + Initials, + Adaptors } IndexEntryType; void CreateHtmlIndex(IndexEntryType type, const std::string& filename); + /// Sets the executer who created the factory (if any) + void SetExecuter(ExecuterPointer e) { mExecuter = e; } + /// Gets the executer who created the factory (if any) + ExecuterPointer GetExecuter() { return mExecuter.lock(); } + /// Gets the executer who created the factory (if any) - const + // const Executer::Pointer GetExecuter() const { return mExecuter.lock(); } + + std::string GetPackageNameOfaBlackBox(std::string boxType); + + private: - bool DoLoadPackage(std::string libname, - std::string pkgname, - std::string path, - bool v); - - /// The structure storing info on a package - class PackageInfoType - { - public : - /// Ctor - PackageInfoType() {} - /// Dtor - ~PackageInfoType() {} - /// The pointer on the package - Package* mPackage; - /// The handler of the dynamic library - DynamicLibraryHandler mDynamicLibraryHandler; - }; - /// The type of map of packages - typedef std::map< std::string, PackageInfoType > PackageMapType; + /// The map of packages PackageMapType mPackageMap; + /// The executer which created the factory (if any) + ExecuterWeakPointer mExecuter; + + bool DoLoadPackage(std::string libname, + std::string pkgname, + std::string path); void CloseAllPackages(); void ClosePackage(PackageMapType::iterator& i); @@ -114,104 +183,6 @@ namespace bbtk // class Factory - /// SYSTEM METHOD : Global method returning the global factory object pointer - inline Factory*& GlobalFactoryPointer() - { - static Factory* f = 0; - return f; - } - - /// SYSTEM METHOD : Global method returning the global factory object - inline Factory* GetGlobalFactory() - { - if (!GlobalFactoryPointer()) - { - GlobalFactoryPointer() = new Factory; - } - return GlobalFactoryPointer(); - } - - /// SYSTEM METHOD : Deletes the global factory pointer - inline void DeleteGlobalFactory() - { - if (GlobalFactoryPointer()) - { - delete GlobalFactoryPointer(); - } - } - - inline void LoadPackage( const std::string& name, - bool use_configuration_file = true, bool verbose = false ) - { - GetGlobalFactory()->LoadPackage(name,use_configuration_file, verbose); - } - - inline void UnLoadPackage( const std::string& name ) - { - GetGlobalFactory()->UnLoadPackage(name); - } - - inline void PrintPackages(bool details = true, bool adaptors = false) - { - GetGlobalFactory()->PrintPackages(details,adaptors); - } - - inline void HelpPackage(const std::string& name, bool adaptors = false) - { - GetGlobalFactory()->HelpPackage(name,adaptors); - } - - inline void HelpBlackBox(const std::string& name, bool full=true) - { - GetGlobalFactory()->HelpBlackBox(name,full); - } - - - inline void ShowGraphTypes(const std::string& name) - { - GetGlobalFactory()->ShowGraphTypes(name); - } - - inline void InsertPackage( Package* p) - { - GetGlobalFactory()->InsertPackage(p); - } - - inline void RemovePackage( Package* p) - { - GetGlobalFactory()->RemovePackage(p); - } - - inline const Package* GetPackage(const std::string& name) - { - return GetGlobalFactory()->GetPackage(name); - } - - inline BlackBox* NewBlackBox(const std::string& type, - const std::string& name) - { - return GetGlobalFactory()->NewBlackBox(type,name); - } - - inline BlackBox* NewAdaptor(TypeInfo typein, - TypeInfo typeout, - const std::string& name) - { - return GetGlobalFactory()->NewAdaptor(typein,typeout,name); - } - - inline Connection* NewConnection(BlackBox* from, - const std::string& output, - BlackBox* to, - const std::string& input) - { - return GetGlobalFactory()->NewConnection(from,output,to,input); - } - - inline void WriteDotFilePackagesList(FILE *ff) - { - GetGlobalFactory()->WriteDotFilePackagesList(ff); - } }// namespace bbtk