]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkBlackBox.h
#3005 BBTK Feature New Normal - TypeName in message system BlackBox
[bbtk.git] / kernel / src / bbtkBlackBox.h
index 9b1775e84522344d1b239d77bbc0fa6e11c4a4ca..db02118273aaa83c2f12a3e7f912c656dca50d1e 100644 (file)
@@ -1,33 +1,38 @@
+/*
+ # ---------------------------------------------------------------------
+ #
+ # 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: bbtkBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2011/03/01 14:50:28 $
-  Version:   $Revision: 1.31 $
+  Date:      $Date: 2012/11/16 08:49:01 $
+  Version:   $Revision: 1.34 $
 =========================================================================*/
 
-/* ---------------------------------------------------------------------
-
-* 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.
-* ------------------------------------------------------------------------ */
-
 
 
 /**
 #include <set>
 
 // Signal/slot mechanism for output change events
-#include <boost/signal.hpp>
+#include <boost/signals2/signal.hpp>
 #include <boost/bind.hpp>
 
 
 #define bbtkBlackBoxMessage(key,level,mess) \
-  bbtkMessage(key,level,"["<<bbGetName()<<"] "<<mess)
+  bbtkMessage(key,level,"["<<bbGetTypeName()<<":"<<bbGetName()<<"] "<<mess)
 #define bbtkBlackBoxDebugMessage(key,level,mess)       \
-  bbtkDebugMessage(key,level,"["<<bbGetName()<<"] "<<mess)
+  bbtkDebugMessage(key,level,"["<<bbGetTypeName()<<":"<<bbGetName()<<"] "<<mess)
 
 namespace bbtk
 {
@@ -79,8 +84,8 @@ namespace bbtk
     //==================================================================
     // Types
     //==================================================================
-    typedef boost::signals::trackable OutputChangeObserverType;
-    typedef boost::signal<void (bbtk::BlackBox::Pointer,
+    typedef boost::signals2::trackable OutputChangeObserverType;
+    typedef boost::signals2::signal<void (bbtk::BlackBox::Pointer,
                                const std::string&,
                                IOStatus)>  OutputChangeSignalType;
     typedef OutputChangeSignalType::slot_function_type
@@ -296,9 +301,10 @@ namespace bbtk
  
     typedef enum 
      {
-      Pipeline,
-      Always,
-      Reactive
+      bbPipeline,
+      bbAlways,
+      bbReactive,
+         bbManual
      }
     BoxProcessModeValue;
     
@@ -308,16 +314,18 @@ namespace bbtk
     virtual bool bbBoxProcessModeIsReactive() const;
     /// Returns true iff the input 'BoxProcessMode' is set to 'Always' (or a synonym)
     virtual bool bbBoxProcessModeIsAlways() const;
+       /// Returns true iff the input 'BoxProcessMode' is set to 'Manual' (or a synonym)
+       virtual bool bbBoxProcessModeIsManual() const;
 
     /// Returns the value of the input 'BoxExecute'
     Void bbGetInputBoxExecute() { return Void(); }
     /// Sets the value of the input 'BoxExecute'
-    void bbSetInputBoxExecute(Void = 0) {}
+         void bbSetInputBoxExecute(Void = 0) {  }
 
     /// Returns the value of the output 'BoxChange'
     Void bbGetOutputBoxChange() { return Void(); }
     /// Sets the value of the output 'BoxChange'
-    void bbSetOutputBoxChange(Void = 0) { }
+    void bbSetOutputBoxChange(Void = 0) {  }
     //@}
     //==================================================================
 
@@ -480,7 +488,7 @@ namespace bbtk
 
     //==================================================================
     /// Computes the final IOStatus of inputs and outputs after processing
-    void bbComputePostProcessStatus();
+virtual    void bbComputePostProcessStatus();
     //@}
     //==================================================================
 
@@ -559,17 +567,13 @@ namespace bbtk
     //@{
 
     /// Connects the input <name> to the connection c
-    virtual void bbConnectInput( const std::string& name,
-                                Connection* c);
+    virtual void bbConnectInput( const std::string& name, Connection* c);
     /// Connects the output <name> to the connection c
-    virtual void bbConnectOutput( const std::string& name,
-                                 Connection* c);
+    virtual void bbConnectOutput( const std::string& name, Connection* c);
     /// Disconnects the input <name> from the connection c
-    virtual void bbDisconnectInput( const std::string& name,
-                                   Connection* c);
+    virtual void bbDisconnectInput( const std::string& name, Connection* c);
     /// Disconnects the output <name> from the connection c
-    virtual void bbDisconnectOutput( const std::string& name,
-                                    Connection* c);
+    virtual void bbDisconnectOutput( const std::string& name, Connection* c);
     //@}
     //==================================================================
 
@@ -582,8 +586,6 @@ namespace bbtk
     /// Sets the bbmExecuting bool returned by bbGetExecuting
     void bbSetExecuting(bool b) { bbmExecuting = b; }
 
-  protected:
-
     //==================================================================
   protected:
 
@@ -642,6 +644,7 @@ namespace bbtk
     /// 0 : "Pipeline" mode
     /// 1 : "Always" mode
     /// 2 : "Reactive" mode
+       /// 3 : "Manual" mode
     std::string bbmBoxProcessMode;
     /// The parent of the black box in the ComplexBlackBox hierarchy
     BlackBox::WeakPointer bbmParent;
@@ -655,6 +658,9 @@ namespace bbtk
     ///  Map that contains the input connectors of the black box
     InputConnectorMapType mInputConnectorMap;
     //==================================================================
+         
+         
+         bool bbLetRecursiveExecuteManualMode;
  };
   // Class BlackBox