]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkConnection.cxx
#2696 BBTK Bug New Normal - BoxChange BoxExecute not responding at the second actio...
[bbtk.git] / kernel / src / bbtkConnection.cxx
index 38051fbff9e41ac2b83df54e4bf2e5e53062ca38..e6ee23851e7288d08e4cfc37a460528bb797867d 100644 (file)
@@ -1,32 +1,39 @@
-/*=========================================================================                                                                               
+/*
+ # ---------------------------------------------------------------------
+ #
+ # 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: bbtkConnection.cxx,v $
   Language:  C++
-  Date:      $Date: 2008/12/08 14:02:15 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2012/11/16 08:49:01 $
+  Version:   $Revision: 1.22 $
 =========================================================================*/
 
-/* ---------------------------------------------------------------------
-
-* 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.
-* ------------------------------------------------------------------------ */                                                                         
+                                                                        
 
 /**
  *\file
 #include "bbtkMessageManager.h"
 #include "bbtkBlackBoxOutputConnector.h"
 
+#define bbtkCMessage(key,level,mess) \
+  bbtkMessage(key,level,"["<<GetFullName()<<"] "<<mess)
+#define bbtkCDebugMessage(key,level,mess)      \
+  bbtkDebugMessage(key,level,"["<<GetFullName()<<"] "<<mess)
+
 namespace bbtk
 {
   const std::string IOSTATUS_STRING[3] = 
@@ -54,13 +66,13 @@ namespace bbtk
                                      const std::string& input ,
                                      const Factory::Pointer f  )
   {
-    bbtkDebugMessage("object",1,"##> Connection::Connection(\""
+    bbtkDebugMessage("object",1,"##> Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);
     Connection::Pointer p = 
       MakePointer(new Connection(from,output,to,input,f));
-    bbtkDebugMessage("object",1,"<## Connection::Connection(\""
+    bbtkDebugMessage("object",1,"<## Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);
@@ -79,14 +91,14 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       mFromAny(false),
       mToAny(false)
   {
-    bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+    bbtkDebugMessage("object",2,"==> Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
-    bbtkDebugMessage("connection",1,"==> Connection::Connection(\""
-                    <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
-                    <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+    bbtkDebugMessage("connection",1,"==> Connection(\""
+                    <<from->bbGetName()<<"\",\""<<output<<"\",\""
+                    <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
     
@@ -116,9 +128,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       {
        if ( from->bbGetOutputType(output) == typeid(Data) )
          {
-           bbtkWarning("Connection '"
-                       <<GetFullName()
-                       <<"' : '"<<from->bbGetName()<<"."<<output
+           bbtkWarning("Connection: '"<<from->bbGetName()<<"."<<output
                        <<"' is of type <"
                        <<HumanTypeName<Data>()
                        <<"> : type compatibility with '"
@@ -129,7 +139,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          }
        else if (  to->bbGetInputType(input) == typeid(Data) )
          {   
-           bbtkDebugMessage("Kernel",8," -> '"<<input<<"' type is "
+           bbtkDebugMessage("kernel",8," -> '"<<input<<"' type is "
                             <<TypeName<Data>()<<" : can receive any data"
                             <<std::endl);
            mToAny = true;
@@ -156,12 +166,12 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       }
 
 
-    mFrom = from;
-    mOriginalFrom = from;
-    mTo = to;
-    mOriginalTo = to;
-    mInput = mOriginalInput = input;
-    mOutput = mOriginalOutput = output;
+    mFrom                      = from;
+    mOriginalFrom      = from;
+    mTo                        = to;
+    mOriginalTo        = to;
+    mInput                     = mOriginalInput        = input;
+    mOutput            = mOriginalOutput       = output;
 
      // Lock this pointer !!!
     //Pointer p = MakePointer(this,true);
@@ -171,12 +181,12 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
     from->bbGetOutputConnector(output).AddChangeObserver(boost::bind(&bbtk::Connection::OnOutputChange,this, _1, _2, _3));
 
     
-    bbtkDebugMessage("connection",1,"<== Connection::Connection(\""
-                    <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
-                    <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+    bbtkDebugMessage("connection",1,"<== Connection(\""
+                    <<from->bbGetName()<<"\",\""<<output<<"\",\""
+                    <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
-    bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+    bbtkDebugMessage("object",2,"<== Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
@@ -189,13 +199,13 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
                                      BlackBox::Pointer to, 
                                      const std::string& input )
   {
-    bbtkDebugMessage("object",1,"##> Connection::Connection(\""
+    bbtkDebugMessage("object",1,"##> Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);
     Connection::Pointer p = 
       MakePointer(new Connection(from,output,to,input));
-    bbtkDebugMessage("object",1,"<## Connection::Connection(\""
+    bbtkDebugMessage("object",1,"<## Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);
@@ -213,14 +223,14 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       mFromAny(false),
       mToAny(false)
   {
-    bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+    bbtkDebugMessage("object",2,"==> Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
-    bbtkDebugMessage("connection",1,"==> Connection::Connection(\""
-                    <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
-                    <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+    bbtkDebugMessage("connection",1,"==> Connection(\""
+                    <<from->bbGetName()<<"\",\""<<output<<"\",\""
+                    <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
     
@@ -263,7 +273,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          }
        else if (  to->bbGetInputType(input) == typeid(Data) )
          {   
-           bbtkDebugMessage("Kernel",8," -> '"<<input<<"' type is "
+           bbtkDebugMessage("kernel",8," -> '"<<input<<"' type is "
                             <<TypeName<Data>()<<" : can receive any data"
                             <<std::endl);
            mToAny = true;
@@ -289,12 +299,12 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
 
     from->bbGetOutputConnector(output).AddChangeObserver(boost::bind(&bbtk::Connection::OnOutputChange,this, _1, _2, _3));
     
-    bbtkDebugMessage("connection",1,"<== Connection::Connection(\""
-                    <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
-                    <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+    bbtkDebugMessage("connection",1,"<== Connection(\""
+                    <<from->bbGetName()<<"\",\""<<output<<"\",\""
+                    <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
 
-    bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+    bbtkDebugMessage("object",2,"==> Connection(\""
                     <<from->bbGetName()<<"\",\""<<output<<"\",\""
                     <<to->bbGetName()<<"\",\""<<input<<"\")"
                     <<std::endl);    
@@ -305,9 +315,9 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
   /// Dtor 
   Connection::~Connection()
   {
-    bbtkDebugMessage("object",2,
-                    "==> Connection::~Connection() ["
-                    <<GetFullName()<<"]"<<std::endl);
+    bbtkCDebugMessage("object",4,
+                    "==> ~Connection()"
+                    <<std::endl);
 
     if (mAdaptor) mAdaptor.reset();
     if (mFrom!=0) 
@@ -318,7 +328,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       }
     else 
       {
-       bbtkInternalError("Connection::~Connection() : invalid initial box pointer");
+       bbtkInternalError("~Connection() : invalid initial box pointer");
       }
     if (mTo!=0) 
       {
@@ -327,68 +337,73 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       }
     else 
       {
-       bbtkInternalError("Connection::~Connection() : invalid final box pointer");
+       bbtkInternalError("~Connection() : invalid final box pointer");
       }
 
 
-    bbtkDebugMessage("object",2,
-                    "<== Connection::~Connection() ["
-                    <<GetFullName()<<"]"<<std::endl);
+    bbtkCDebugMessage("object",4,
+                     "<== ~Connection()"
+                     <<std::endl);
   }
   //==================================================================
   
   //==================================================================
-  /// Backward Update
-  void Connection::BackwardUpdate()
+  /// Recursive execution
+  void Connection::RecursiveExecute()
   {
-    bbtkDebugMessage("process",5,
-                    "===> Connection::BackwardUpdate() ["
-                    <<GetFullName()<<"]"<<std::endl);
+    bbtkCDebugMessage("process",4,
+                     "===> Connection::RecursiveExecute()"
+                     <<std::endl);
 
-    mFrom->bbBackwardUpdate(GetThisPointer<Connection>());
+    /*
+    // If box from already executing : nothing to do
+    if (mFrom->bbGetExecuting()) 
+      {
+       bbtkDebugMessage("process",3,
+                        " -> "<<mFrom->bbGetName()
+                        <<" already executing : abort"<<std::endl);
+       return; 
+
+      }
+    */
+
+    mFrom->bbRecursiveExecute(GetThisPointer<Connection>());
 
     TransferData();
 
     // Transfer status
     IOStatus s = MODIFIED;
     if ( mFrom->bbGetOutputConnector(mOutput).GetStatus() == OUTOFDATE) 
-      s = OUTOFDATE,
+      {
+       s = OUTOFDATE;
+      }
     mTo->bbGetInputConnector(mInput).SetStatus(s);
-
-    bbtkDebugMessage("process",5,
-                    "<=== Connection::BackwardUpdate() ["
-                    <<GetFullName()<<"]"<<std::endl);
-    return; // s;
+    
+    bbtkCDebugMessage("process",4,
+                    " --> '"<<mTo->bbGetName()<<"."<<mInput
+                    <<" ["<<&mTo->bbGetInputConnector(mInput)<<"] "
+                    <<"' new status '"
+                    <<GetIOStatusString(s)
+                    <<"'"
+                    << std::endl);
+
+    bbtkCDebugMessage("process",4,
+                    "<=== Connection::RecursiveExecute()"
+                     <<std::endl);
+    return; 
   }
   //==================================================================
 
-  /*
-  //==================================================================
-  /// Forward Update
-  void Connection::ForwardUpdate()
-  {
-    bbtkDebugMessageInc("process",2,
-                       "Connection::ForwardUpdate() ["
-                       <<GetFullName()<<"]"<<std::endl);
-
-  
-    TransferData();
-
-    mTo->bbForwardUpdate(this);
 
-    bbtkDebugDecTab("process",2);
-  }
-  //==================================================================
-  */
 
   //==================================================================
   /// Transfers the data from the source output to the target input
   /// doing necessary conversions (adaptation or pointer cast)
   void Connection::TransferData()
   {
-    bbtkDebugMessageInc("data",3,
-                       "Connection::TransferData() ["
-                       <<GetFullName()<<"]"<<std::endl);
+    bbtkCDebugMessage("data",3,
+                     "Connection::TransferData()"
+                     <<std::endl);
     
     
     // If an adaptor was created we need to adapt the data
@@ -403,22 +418,28 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
     // If no adaptor but source type is an any and target is not an any
     else if ( mFromAny && (! mToAny) )
       {
-       bbtkDebugMessage("data",3,
+       bbtkCDebugMessage("data",3,
                         " * Source type is an "
                         <<HumanTypeName<Data>()
                         <<" which contains a <"
                         <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
                         <<">"<<std::endl);
-       bbtkDebugMessage("data",3,
+       bbtkCDebugMessage("data",3,
                         " * Target type is <"
                         <<HumanTypeName(mTo->bbGetInputType(mInput))
                         <<">"<<std::endl);
        
+       // 0) If from any contents void : nothing to do 
+       if (mFrom->bbGetOutput(mOutput).type() == typeid(void)) 
+         {
+           bbtkCDebugMessage("data",3,
+                            " -> Source is void : nothing to transfer!"<<std::endl);
+         }
        // 1) Test strict type matching between any content and target
-       if (mFrom->bbGetOutput(mOutput)
+       else if (mFrom->bbGetOutput(mOutput)
            .contains( mTo->bbGetInputType(mInput) ) )
          {
-           bbtkDebugMessage("data",3,
+           bbtkCDebugMessage("data",3,
                             " -> Equal types : transfer ok"<<std::endl);
            mTo->bbSetInput( mInput, 
                             mFrom->bbGetOutput(mOutput),
@@ -440,7 +461,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
              }
            if (adaptor)  
              {
-               bbtkDebugMessage("data",3," -> Adaptor found : using it"
+               bbtkCDebugMessage("data",3," -> Adaptor found : using it"
                                 <<std::endl);
                  adaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
                adaptor->bbExecute();
@@ -454,7 +475,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
                      (mTo->bbGetDescriptor()->GetInputDescriptor(mInput)
                       ->IsPointerType()) )
              {
-               bbtkDebugMessage("data",3,
+               bbtkCDebugMessage("data",3,
                                 " -> No adaptor found but source and target types are both pointers : trying up or down cast"<<std::endl);
                
                void* nptr = 
@@ -493,32 +514,16 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
 
   }
   //==================================================================
-  
-  /*
-  //==================================================================
-  /// Modified
-  void Connection::SetModifiedStatus()
-  {
-    bbtkDebugMessage("modified",2,
-                    "==> Connection::SetModifiedStatus() ["
-                    <<GetFullName()<<"]"<<std::endl);
-    
-    if (mAdaptor) mAdaptor->bbSetModifiedStatus();
-    
-    mTo->bbSetModifiedStatus(  mTo->bbGetInputConnectorMap().find(mInput)->second );
-    
-  }
-  //==================================================================
-  */
+
   //==================================================================
   /// From.Output change propagation
   void Connection::OnOutputChange(bbtk::BlackBox::Pointer, const std::string&, 
                                  IOStatus status)
   {
-    bbtkDebugMessage("change",2,
-                    "==> Connection::OnOutputChange("<<status<<") ["
-                    <<GetFullName()<<"]"<<std::endl);
+    bbtkCDebugMessage("change",2,
+                    "==> Connection::OnOutputChange("
+                    <<GetIOStatusString(status)<<")"
+                    <<std::endl);
     if (mAdaptor) 
       {
            BlackBoxInputConnector* ac = mAdaptor->bbGetInputConnectorMap().find("In")->second;
@@ -554,7 +559,8 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
   //==================================================================
   void Connection::Check() const
   {
-    bbtkMessage("debug",1,"** Checking Connection "<<(void*)this<<" ["<<GetFullName()<<"]"
+    bbtkMessage("debug",1,"** Checking Connection "<<(void*)this<<" ["
+               <<GetFullName()<<"]"
                <<std::endl);
     if (mFrom==0) 
       {
@@ -562,12 +568,12 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
       }
     else
       {
-       bbtkMessage("debug",2," - From : "<<mFrom->bbGetFullName()<<std::endl);
+       bbtkMessage("debug",2," - From : "<<mFrom->bbGetName()<<std::endl);
        if (!mFrom->bbHasOutput(mOutput))
          {
            bbtkError("** Checking Connection "<<(void*)this
                       <<" ["<<GetFullName()<<"] : "
-                     << mFrom->bbGetFullName()<<" does not have output '"
+                     << mFrom->bbGetName()<<" does not have output '"
                      <<mOutput<<"'");
          }     
        bbtkMessage("debug",2," - From : Output '"<<mOutput<<"' exists"<<std::endl);
@@ -577,7 +583,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          {
             bbtkError("** Checking Connection "<<(void*)this
                       <<" ["<<GetFullName()<<"] : "
-                      <<mFrom->bbGetFullName()<<" output '"
+                      <<mFrom->bbGetName()<<" output '"
                       <<mOutput<<"' is not in OutputConnectorMap");
          }
        bbtkMessage("debug",2," - From : Output '"<<mOutput
@@ -600,9 +606,8 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          {
            bbtkError("** Checking Connection "<<(void*)this
                      <<" ["<<GetFullName()<<"] : "
-                     << "Connection ["<<GetFullName()<<"] : "
                      <<" OutputConnector '"
-                     <<mOutput<<"' of "<<mFrom->bbGetFullName()
+                     <<mOutput<<"' of "<<mFrom->bbGetName()
                      <<" does not point to this connection");
            
          }
@@ -621,13 +626,13 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
        //      std::cout << mTo << std::endl;
        //      std::cout << mTo->bbGetDescriptor() << std::endl;
        //      std::cout << mTo->bbGetDescriptor()->GetTypeName() << std::endl;
-       //      mTo->bbGetFullName();
-       bbtkMessage("debug",2," - To   : "<<mTo->bbGetFullName()<<std::endl);
+       //      mTo->bbGetName();
+       bbtkMessage("debug",2," - To   : "<<mTo->bbGetName()<<std::endl);
        if (!mTo->bbHasInput(mInput))
          {
            bbtkError("** Checking Connection "<<(void*)this
                      <<" ["<<GetFullName()<<"] : "
-                     <<mTo->bbGetFullName()<<" does not have input '"
+                     <<mTo->bbGetName()<<" does not have input '"
                      <<mInput<<"'");
          }     
        bbtkMessage("debug",2," - To   : Input '"<<mInput<<"' exists"<<std::endl);
@@ -637,7 +642,7 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          {
             bbtkError("** Checking Connection "<<(void*)this
                       <<" ["<<GetFullName()<<"] : "
-                      <<mTo->bbGetFullName()<<" input '"
+                      <<mTo->bbGetName()<<" input '"
                       <<mInput<<"' is not in InputConnectorMap");
          }
        bbtkMessage("debug",2," - To   : Input '"<<mInput
@@ -647,9 +652,8 @@ Connection::Connection(BlackBox::Pointer from, const std::string& output,
          {
            bbtkError("** Checking Connection "<<(void*)this
                      <<" ["<<GetFullName()<<"] : "
-                     <<"Connection "<<GetFullName()<<" : "
                      <<" InputConnector '"
-                     <<mInput<<"' of "<<mTo->bbGetFullName()
+                     <<mInput<<"' of "<<mTo->bbGetName()
                      <<" does not point to this connection");
     
          }