bbtkBlackBox.h

Go to the documentation of this file.

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

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

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

#include "bbtkSystem.h"
#include "bbtkBlackBoxDescriptor.h"
#include "bbtkBlackBoxInputConnector.h"
#include "bbtkBlackBoxOutputConnector.h"
#include <set>

namespace bbtk
{

  
  struct Void { Void(int = 0) {} };
  
  class Factory;
  class Connection;

  class BBTK_EXPORT BlackBox : public Object
  {
    BBTK_ABSTRACT_OBJECT_INTERFACE(BlackBox);
  public: 
    //==================================================================
    // INTERFACE
    //==================================================================
 
    typedef std::map<std::string, BlackBoxOutputConnector*> 
    OutputConnectorMapType;
    typedef std::map<std::string, BlackBoxInputConnector*> 
    InputConnectorMapType;

    virtual BlackBoxDescriptor::Pointer bbGetDescriptor() const = 0;

    virtual BlackBox::Pointer bbClone(const std::string& name) = 0;

    virtual void bbUserDelete();

    const std::string& bbGetTypeName() const 
      { return bbGetDescriptor()->GetTypeName(); }
 
    
    const std::string& bbGetName() const { return bbmName; }

    virtual std::string bbGetFullName() const;

    virtual std::string bbGetNameWithParent() const;
    
    BlackBox::Pointer bbGetParent() const { return bbmParent.lock(); }


    virtual void bbExecute(bool force = false);

    virtual void bbSetModifiedStatus(BlackBoxInputConnector* c = 0);
    virtual void bbSignalOutputModification(bool reaction = true);
    virtual void bbSignalOutputModification( const std::string& output_name,
bool reaction = true);
    virtual void bbSignalOutputModification( const std::vector<std::string>& output_name,
bool reaction = true);

    virtual const IOStatus& bbGetStatus() const { return bbmStatus; }


    virtual bool bbHasInput(const std::string& label) const;
    virtual bool bbHasOutput(const std::string& label) const;

    virtual TypeInfo bbGetInputType( const std::string &label ) const;
    virtual TypeInfo bbGetOutputType( const std::string &label ) const;

    virtual Data bbGetInput( const std::string &name )  = 0;
    virtual Data bbGetOutput( const std::string &name ) = 0;

    virtual void bbSetInput( const std::string &name, Data data,
                             bool setModified = true ) = 0;
    virtual void bbBruteForceSetInputPointer( const std::string &name, 
                                              void* data, 
                                              bool setModified = true) =0;
    virtual void bbSetOutput( const std::string &name, Data data) = 0;


    InputConnectorMapType&  bbGetInputConnectorMap() 
    { return mInputConnectorMap; }
    OutputConnectorMapType& bbGetOutputConnectorMap() 
    { return mOutputConnectorMap; }
    const InputConnectorMapType&  bbGetInputConnectorMap() const 
    { return mInputConnectorMap; } 
    const OutputConnectorMapType& bbGetOutputConnectorMap() const 
    { return mOutputConnectorMap; }      
 

    virtual void bbGetHelp(bool full=true) const;


    //==================================================================
    // Common inputs / outputs to all boxes
    std::string bbGetInputBoxProcessMode() { return bbmBoxProcessMode; }
    void bbSetInputBoxProcessMode(std::string a) { bbmBoxProcessMode = a; }
    typedef enum
      {
        Pipeline,
        Always,
        Reactive
      }
      BoxProcessModeValue;
    BoxProcessModeValue bbGetBoxProcessModeValue() const;
  
    virtual bool bbBoxProcessModeIsReactive() const;

    virtual bool bbBoxProcessModeIsAlways() const;

    Void bbGetInputBoxExecute() { return Void(); }
    void bbSetInputBoxExecute(Void = 0) {}

    Void bbGetOutputBoxChange() { return Void(); }
    void bbSetOutputBoxChange(Void = 0) { bbSetModifiedStatus(); }

    //==================================================================    


    //==================================================================    

    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 void bbShowRelations(BlackBox::Pointer parentblackbox, 
                                 int detail, int level
                                 );
    
    std::string bbGetOutputAsString( const std::string &output ); //,Factory *factory);
    std::string bbGetInputAsString( const std::string &input); //,Factory *factory);
    virtual BlackBox::Pointer bbFindBlackBox(const std::string &blackboxname) 
    { return BlackBox::Pointer();}

    virtual void Check(bool recursive = true);

        virtual void bbUserOnShow() { }
        void bbUserOnShowWidget(std::string nameInput);


  protected:
    //==================================================================
    // PROTECTED PART : ACCESSIBLE TO THE BlackBox DEVELOPER 
    // (IN INHERITED CLASSES)
    BlackBox(const std::string &name);
    BlackBox(BlackBox& from, const std::string &name);
    //==================================================================


    //==================================================================
    void bbSetStatus( IOStatus t) { bbmStatus = t; } 
    //==================================================================
    
  private:
    friend class Connection;
    friend class ComplexBlackBox;

    void bbSetParent(BlackBox::Pointer p) { bbmParent = p; }
    

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


 


    //==================================================================   
  protected:
    virtual IOStatus bbBackwardUpdate(Connection::Pointer caller) = 0;
    //==================================================================

    //==================================================================
    // virtual void bbForwardUpdate(Connection::Pointer caller) = 0;
    //==================================================================
  protected:
    //==================================================================
    // If excludeParent == true then excludes the upstream box connected to input 'Parent' from recursive update
    IOStatus bbUpdateInputs(bool excludeParent=false);
    //==================================================================

    //==================================================================
    //virtual void bbUpdateChildren( Connection::Pointer caller ) { }
    //==================================================================

    //==================================================================
    // virtual void bbCreateWindow() { }
    virtual void bbShowWindow(Connection::Pointer caller) { }

    virtual void bbHideWindow() {}
    virtual void bbCloseWindow() { }
   //==================================================================

  public: 

    static bool bbGlobalGetSomeBoxExecuting();
    static void bbGlobalSetSomeBoxExecuting(bool b);

    static void bbGlobalSetFreezeExecution(bool b);
    static bool bbGlobalGetFreezeExecution();

    virtual bool bbCanReact() const;
    
  protected:  
    static void bbGlobalAddToExecutionList( BlackBox::Pointer b );
    static void bbGlobalProcessExecutionList();

    //==================================================================
  protected:
    //==================================================================
    virtual void bbAllocateConnectors();
    virtual void bbDesallocateConnectors();
    virtual void bbCopyIOValues(BlackBox& from);
    //==================================================================

    // Black box objects have a special deleter 
    // which must take care of releasing the descriptor 
    // **AFTER** the box is deleted 
    // (Releasing it in the destructor may cause dl close and crash)
    struct BBTK_EXPORT Deleter : public Object::Deleter
    { 
      Deleter();
      void Delete(Object* p);
    };

    template <class U>
    static boost::shared_ptr<U> MakeBlackBoxPointer(U* s, bool lock = false)
    {
      return MakePointer(s,BlackBox::Deleter(),lock);
    }

    virtual void bbDelete() { delete this; }
  private:
    
 
    //==================================================================
    // PRIVATE PART 
    IOStatus bbmStatus;
    std::string bbmName;
    std::string bbmPackageName;
        
    std::string bbmBoxProcessMode;

    BlackBox::WeakPointer bbmParent;
    //==================================================================


   //==================================================================
    // ATTRIBUTES
    OutputConnectorMapType mOutputConnectorMap; 
    InputConnectorMapType mInputConnectorMap;
    //==================================================================


 };
  // Class BlackBox







 
}
// namespace bbtk
#endif