]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkAtomicBlackBox.h
Feature #1774
[bbtk.git] / kernel / src / bbtkAtomicBlackBox.h
index 9a00b95c555e4e2e6eab1b4662712eb961d22b52..f9d09f6ce064e3c123cc23b268c5148cdf19596f 100644 (file)
@@ -1,61 +1,42 @@
-/*=========================================================================                                                                               
+/*
+# ---------------------------------------------------------------------
+#
+# 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: bbtkAtomicBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/12/08 12:53:39 $
-  Version:   $Revision: 1.7 $
+  Date:      $Date: 2012/11/16 08:49:01 $
+  Version:   $Revision: 1.12 $
 =========================================================================*/
 
-/* ---------------------------------------------------------------------
-
-* 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.
-* ------------------------------------------------------------------------ */                                                                         
-
-
-/* ---------------------------------------------------------------------
-
-* 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 
- *  \brief class bbtk::AtomicBlackBox : ancestor of all user defined (concrete) black boxes which are atomic (vs. complex boxes which are made up of other (atomic or complex) boxes).
+ *  \brief class bbtk::AtomicBlackBox : ancestor of all user defined (concrete) black boxes which are atomic (vs. ComplexBlackBox objects which are made up of other (atomic or complex) boxes).
  */
 
 /**
@@ -83,6 +64,8 @@ namespace bbtk
     {
       return bbmDescriptorPointer;
     }
+    //==================================================================
+
     //==================================================================
     /// Gets the output Data of a given label
     Data bbGetOutput( const std::string &label );
@@ -113,33 +96,13 @@ namespace bbtk
     /// Constructor from an existing box (copy) with a new instance name 
     AtomicBlackBox(AtomicBlackBox& from, const std::string &name, 
                 bool alloc = true);
-    //==================================================================
-    //==================================================================
     ///  Destructor
     virtual ~AtomicBlackBox();
-    //==================================================================
-
-    //==================================================================
-  protected:
+    /// 
     virtual void bbLockDescriptor() = 0;
-    //  private:
-    //    virtual void bbReleaseDescriptor();
-    //==================================================================
-
-  public:
-    //==================================================================   
-    /// Recursive pipeline processing in backward direction 
-    /// (recursion is in backward direction however execution always goes forward).
-    /// - updates its inputs by calling bbUpdateInputs (which recursively calls bbBackwardUpdate on amont boxes if needed)
-    /// - if the return value of bbUpdateInputs is not UPTODATE 
-    ///    - calls bbProcess
-    ///    - calls bbComputePostProcessStatus
-    virtual void bbBackwardUpdate(Connection::Pointer caller);
     //==================================================================
 
     //==================================================================
-  protected:
-    //==================================================================
     /// Calls the user defined processing method.
     /// Overloaded in WxBlackBox to handle widget creation and show
     virtual void bbProcess() { this->bbUserProcess(); }
@@ -147,8 +110,8 @@ namespace bbtk
 
     //==================================================================
     /// User callback which computes the outputs as a function of the inputs. 
-    /// It is assumed to be deterministic and thus is only called is the inputs have changed 
-    /// (i.e. if the black box is marked as modified)
+    /// It is assumed to be deterministic and thus is only called 
+    /// if the inputs have changed 
     virtual void bbUserProcess() 
     {
       bbtkWarning("AtomicBlackBox::bbUserProcess() not overloaded for box '"
@@ -159,14 +122,20 @@ namespace bbtk
     //==================================================================
 
     //==================================================================
-    /// User callback called in the box contructor
-    virtual void bbUserConstructor() {}
-    /// User callback called in the box copy constructor
-    virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer) {}
-    /// User callback called in the box destructor
-    virtual void bbUserDestructor() {}
+    /// *** TO BE REMOVED WHEN EVERYTHING IS OK ***
+    /// CHANGED RETURN TYPE OF bbUserConstructor FROM void TO int
+    /// TO PRODUCE COMPILATION ERROR IF AN USER DECLARES THE OLD 
+    /// METHOD bbUserConstructor IN ITS BOX
+    virtual int bbUserConstructor() { return 0; }
+    /// *** TO BE REMOVED WHEN EVERYTHING IS OK ***
+    /// THE SAME AS bbUserConstructor
+    virtual int bbUserCopyConstructor(bbtk::BlackBox::Pointer) { return 0; }
+    /// *** TO BE REMOVED WHEN EVERYTHING IS OK ***
+    /// THE SAME AS bbUserConstructor
+    virtual int bbUserDestructor() { return 0; }
     //==================================================================    
 
+
      //==================================================================
   private:
     //================================================================== 
@@ -183,8 +152,7 @@ namespace bbtk
 
   };
   // Class AtomicBlackBox
-  //===========================================================================
-
+  //====================================================================
 
 
 }