Feature #1774

[bbtk.git] / kernel / src / bbtkConnection.h

diff --git a/kernel/src/bbtkConnection.h b/kernel/src/bbtkConnection.h
index f1494f01397346cbdda5a6a6c77918efabcbdc86..5d3965ee787eec3becd4e56a80412ee112a6a75d 100644 (file)
--- a/kernel/src/bbtkConnection.h
+++ b/kernel/src/bbtkConnection.h
@@ -1,20 +1,40 @@
+/*
+ # ---------------------------------------------------------------------
+ #
+ # 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.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/18 12:59:15 $
-  Version:   $Revision: 1.6 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See doc/license.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-                                                                                
-     This software is distributed WITHOUT ANY WARRANTY; without even
-     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-     PURPOSE.  See the above copyright notices for more information.
-                                                                                
+  Date:      $Date: 2012/11/16 08:49:01 $
+  Version:   $Revision: 1.14 $
 =========================================================================*/
+
+                                                                       
+
 /**
  *\file
  *\brief Class bbtk::Connection
@@ -43,14 +63,16 @@ namespace bbtk
   class BlackBoxInputConnector;
   class BlackBoxOutputConnector;
 
-  /// 
-  typedef int IOStatus;
-  /// 
-  const int MODIFIED = 0;
-  /// 
-  const int UPTODATE = 1;
-  /// 
-  const int UPDATING = 2;
+  /// The type of input / output status 
+  typedef unsigned char IOStatus;
+  /// Up-to-date status value
+  const IOStatus UPTODATE  = 0;
+  /// Modified status value
+  const IOStatus MODIFIED  = 1;
+  /// Out-of-date status value
+  const IOStatus OUTOFDATE = 2;
+
+  BBTK_EXPORT const std::string& GetIOStatusString( IOStatus );
 
 
   class BBTK_EXPORT Connection : public Object
@@ -62,22 +84,25 @@ namespace bbtk
     static Pointer New(BlackBoxPointer from, const std::string& output,
                       BlackBoxPointer to, const std::string& input,
                       const FactoryPointer f);
+    static Pointer New(BlackBoxPointer from, const std::string& output,
+                      BlackBoxPointer to, const std::string& input);
     /// Dtor
     //    ~Connection();
 
     // void Delete();
     
-    /// Amont direction pipeline processing
-    /// 1) call bbBackwardUpdate(this) on the upstream box
-    /// 2) copies the upstream box output to the downstream box input adapting it if needed
-    virtual IOStatus BackwardUpdate();
-
-    /// Aval direction pipeline processing :
-    /// 1) copies the upstream box output to the downstream box input adapting it if needed
-    /// 2) call bbForwardUpdate(this) on the downstream box
-    //    virtual void ForwardUpdate();
+    /// Pipeline processing method
+    /// 1) call bbRecursiveExecute(this) on the from box
+    /// 2) copies the from box output to the to box input 
+    ///    adapting it if needed
+    /// 3) sets the new IOStatus of the to box input to the 
+    ///    status of the from box output
+    void RecursiveExecute();
+    
+    /// Change callback
+    void OnOutputChange(BlackBoxPointer, const std::string&, 
+                       IOStatus);
 
-    virtual void SetModifiedStatus();
     std::string GetFullName() const; 
 
     /// Returns the original initial black box of the connection
@@ -148,7 +173,7 @@ namespace bbtk
     /// Sets the members but does not test compatibility (used by bbtk::AdaptiveConnection)
     //  Connection(BlackBox* from, const std::string& output,
     //        BlackBox* to, const std::string& input, int   );
-    
+  public:   
     void TransferData(); 
 
   private:
@@ -156,6 +181,9 @@ namespace bbtk
     Connection(BlackBoxPointer from, const std::string& output,
               BlackBoxPointer to, const std::string& input,
               const FactoryPointer f);
+    /// Ctor 
+    Connection(BlackBoxPointer from, const std::string& output,
+              BlackBoxPointer to, const std::string& input);
 
   };