bbtkComplexBlackBoxDescriptor.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkComplexBlackBoxDescriptor.h,v $
  Language:  C++
  Date:      $Date: 2008/10/17 08:18:12 $
  Version:   $Revision: 1.6 $
=========================================================================*/

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

* 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 __bbtkComplexBlackBoxDescriptor_h__
#define __bbtkComplexBlackBoxDescriptor_h__

#include "bbtkBlackBoxDescriptor.h"
#include "bbtkComplexBlackBoxInputDescriptor.h"
#include "bbtkComplexBlackBoxOutputDescriptor.h"
#include "bbtkFactory.h"
#include <fstream>

namespace bbtk
{

  class ComplexBlackBox;
  typedef boost::shared_ptr<ComplexBlackBox> ComplexBlackBoxPointer;

  //==========================================================================
  class BBTK_EXPORT ComplexBlackBoxDescriptor : 
    public bbtk::BlackBoxDescriptor
  {
    BBTK_OBJECT_INTERFACE(ComplexBlackBoxDescriptor);
    typedef BlackBoxDescriptor Superclass;
  public:
    friend class ComplexBlackBox;

    static Pointer New(const std::string& name); 
    void SetFactory(Factory::Pointer f) { mFactory = f; }
    Factory::Pointer GetFactory() const { return mFactory.lock(); }

    //    void Release(bool release_package = true);

    //    const Factory* GetFactory() const { return mFactory; }

    virtual BlackBoxPointer NewBlackBox(const std::string& name);

    void Add ( const std::string& type,
               const std::string& name
               ); 

    void Remove( const std::string& name, bool remove_connections = true);

     void Connect ( const std::string& from,
                   const std::string& output,
                   const std::string& to,
                   const std::string& input
                   ); 
    void DefineInput ( const std::string& name,
                       const std::string& box,
                       const std::string& input,
                       const std::string& help);
    void DefineOutput ( const std::string& name,
                       const std::string& box,
                       const std::string& output,
                       const std::string& help);
 
 
    void SetScriptFileName(const std::string& n) { mScriptFileName = n; }
    std::string GetScriptFileName() const { return mScriptFileName; }
   
    void AddToExecutionList( const std::string& box );

    ComplexBlackBoxPointer GetPrototype() { return mPrototype; }
    void PrintBlackBoxes(); 
   
    void GetHelp(bool full=true) const;
 
    void InsertHtmlHelp ( std::ofstream& s, 
                          int detail, int level,
                          const std::string& output_dir = "",
                          bool relative_link = false);

    void InsertHTMLGraph( std::ofstream& s, 
                          int detail, int level, 
                          const std::string& output_dir = "",
                          bool relative_link = false );
    

    virtual void Check(bool recursive=true) const;
       


  protected:
    ComplexBlackBoxDescriptor(const std::string& name); 

  private:
    Factory::WeakPointer mFactory;
    ComplexBlackBoxPointer mPrototype;
    std::string mScriptFileName;
    
  };
  // class ComplexBlackBoxDescriptor
  //==========================================================================


 
}
// namespace bbtk
#endif