bbtkFactory.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkFactory.h,v $
  Language:  C++
  Date:      $Date: 2010/09/12 14:52:25 $
  Version:   $Revision: 1.18 $
=========================================================================*/

/* ---------------------------------------------------------------------

* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
*
*  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.
* ------------------------------------------------------------------------ */                                                                         

#ifndef __bbtkFactory_h__
#define __bbtkFactory_h__

#include "bbtkPackage.h"

namespace bbtk
{

  class Executer;
  BBTK_FORWARD_DECLARE_POINTER(Executer);

  class BBTK_EXPORT Factory : public Object
  {
    BBTK_OBJECT_INTERFACE(Factory);
    typedef Object Superclass;
  public:
    static Pointer New();

    // @name Packages management

    void GetPackagesList(std::vector<std::string>&);
    void LoadPackage( const std::string& name );
    void UnLoadPackage( const std::string& name );
    void InsertPackage( Package::Pointer );
    void RemovePackage( Package::Pointer );
    Package::Pointer GetPackage(const std::string& name) const;
    typedef std::map< std::string, Package::Pointer > PackageMapType;
    const PackageMapType& GetPackageMap() const { return mPackageMap; }

    // @name Methods which print help

    void PrintHelpListPackages(bool details = true, 
                               bool adaptors = false) const;
    void PrintHelpPackage(const std::string& name, 
                          bool adaptors = false) const;
    void PrintHelpDescriptor(const std::string& name, 
                             std::string& package,
                             bool full=true ) const;
    
    void ShowGraphTypes(const std::string& name) const;
    // @}



    BlackBox::Pointer NewBlackBox(const std::string& type, 
                          const std::string& name) const;
    
    BlackBox::Pointer NewAdaptor(const DataInfo& typein,
                         const DataInfo& typeout,
                         const std::string& name) 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;


    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);

    void Reset();
    
    void Check() const;

    typedef enum
      {
        Packages,
        Categories,
        Initials,
        Adaptors
      }
      IndexEntryType;
    void CreateHtmlIndex(IndexEntryType type, const std::string& filename);

    void SetExecuter(ExecuterPointer e) { mExecuter = e; }
    ExecuterPointer GetExecuter() { return mExecuter.lock(); }
    //    const Executer::Pointer GetExecuter() const { return mExecuter.lock(); }

          std::string GetPackageNameOfaBlackBox(std::string boxType);


  private:


    PackageMapType mPackageMap;

    ExecuterWeakPointer mExecuter;

    bool DoLoadPackage(std::string libname,
                       std::string pkgname,
                       std::string path);
    void CloseAllPackages();
    void ClosePackage(PackageMapType::iterator& i);

  };
  // class Factory



}// namespace bbtk



#endif