bbtkComplexBlackBox.h

Go to the documentation of this file.

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

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

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

#include "bbtkBlackBox.h"
#include "bbtkComplexBlackBoxDescriptor.h"
//#include "bbtkComplexBlackBoxInputDescriptor.h"
//#include "bbtkComplexBlackBoxOutputDescriptor.h"
#include <list>

namespace bbtk
{


 
  //==================================================================
  class BBTK_EXPORT ComplexBlackBox : public bbtk::BlackBox
  {
    BBTK_OBJECT_INTERFACE(ComplexBlackBox);
    friend class ComplexBlackBoxDescriptor;
    typedef BlackBox Superclass;
  public: 
    //==================================================================
    // PUBLIC PART : ACCESSIBLE TO THE END-USER
    BlackBoxDescriptor::Pointer bbGetDescriptor() const { return mDescriptor.lock(); }
    //BlackBox* bbNew(const std::string& name);
    BlackBox::Pointer bbClone(const std::string& name);

    void Clear();
    void SetAsPrototype() { mLockedDescriptor.reset(); }
    bool IsAPrototype() const { return (!mLockedDescriptor); }

    std::string bbGetNameWithParent() const;

    void bbExecute(bool force = false);
  
    Data bbGetOutput( const std::string &label );
    Data bbGetInput ( const std::string &label );
    void bbSetOutput( const std::string &name, Data data);
    void bbSetInput ( const std::string &name, Data data,
                      bool setModified = true);
    void bbBruteForceSetInputPointer( const std::string &name, 
                                      void* data, 
                                      bool setModified = true);

    virtual void bbConnectInput( const std::string& name, Connection* c);
    virtual void bbConnectOutput( const std::string& name, Connection* c);

    BlackBox::Pointer bbGetBlackBox( const std::string& name );

    typedef std::map<std::string, BlackBox::Pointer> BlackBoxMapType;

    const BlackBoxMapType& bbGetBlackBoxMap() { return mBlackBoxMap; }

    void bbPrintBlackBoxes();

    void bbInsertHTMLGraph(  std::ofstream& s, 
                             int detail, 
                             int level,
                             bool instanceOrtype,
                             const std::string& output_dir,
                             bool relative_link );

    virtual void bbWriteDotFileBlackBox(FILE *ff,
                                        BlackBox::Pointer parentblackbox, 
                                        int detail, int level,
                                        bool instanceOrtype,
                                        bool relative_link );
    
    virtual void bbWriteDotInputOutputName(FILE *ff,
                                           bool inputoutput, 
                                           int detail, int level);
    
    virtual BlackBox::Pointer bbFindBlackBox(const std::string &blackboxname);
    

    void Check(bool recursive=true);

       

  protected:
    //==================================================================
    // PROTECTED PART : ACCESSIBLE TO ComplexBlackBoxDescriptor
    static ComplexBlackBox::Pointer 
    New(const std::string &name,
        ComplexBlackBoxDescriptor::Pointer desc);
                                 
  private:                       
    ComplexBlackBox(const std::string &name,
                    ComplexBlackBoxDescriptor::Pointer desc);
    ComplexBlackBox(ComplexBlackBox& from, const std::string &name);
    
  public:
    IOStatus bbBackwardUpdate(Connection::Pointer caller);
    //  void bbForwardUpdate(Connection* caller);
    void bbSetModifiedStatus(BlackBoxInputConnector* c);

  protected:
  


    void bbAddBlackBox( BlackBox::Pointer );
    void bbAddToExecutionList( const std::string& name );
    void bbUnsafeAddBlackBox( BlackBox::Pointer );
    void bbRemoveBlackBox( const std::string& name, 
                           bool remove_connections = true);
    void bbAddConnection( Connection::Pointer );
    
    //    void RemoveConnection( );

    BlackBox::Pointer bbUnsafeGetBlackBox( const std::string& name );

    void bbAllocateConnectors();
    void bbDesallocateConnectors();

  private:
    //==================================================================
    // PRIVATE PART : MEMBERS AND USEFULL INTERNAL METHODS

    //ComplexBlackBox() : BlackBox("") {}
    
    // true if the box is a prototype of a ComplexBlackBoxDescriptor
    //    bool mIsAPrototype;

    ComplexBlackBoxDescriptor::Pointer mLockedDescriptor;
    ComplexBlackBoxDescriptor::WeakPointer mDescriptor;
    
    BlackBoxMapType mBlackBoxMap;
    
    
    typedef std::list<Connection::Pointer> ConnectionListType;
    ConnectionListType mConnectionList;

    std::vector<std::string> mExecutionList;
    
  };
  // Class ComplexBlackBox
  //===========================================================================



}
// namespace bbtk


//#include "bbtkComplexBlackBoxMacros.h"

#endif