]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkAtomicBlackBox.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkAtomicBlackBox.h
index 02cb9a5fa39f894370213ab2f81398ca1342c084..3be67510c8afd8f5a0b24e96c4cae4c913b44a45 100644 (file)
@@ -1,25 +1,61 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkAtomicBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/08 06:59:29 $
-  Version:   $Revision: 1.3 $
-                                                                                
-  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: 2008/12/11 09:50:34 $
+  Version:   $Revision: 1.8 $
 =========================================================================*/
 
+/* ---------------------------------------------------------------------
+
+* 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).
  */
 
 /**
@@ -42,6 +78,13 @@ namespace bbtk
   {
     //==================================================================
   public: 
+    //==================================================================
+    bbtk::BlackBoxDescriptor::Pointer bbGetDescriptor() const
+    {
+      return bbmDescriptorPointer;
+    }
+    //==================================================================
+
     //==================================================================
     /// Gets the output Data of a given label
     Data bbGetOutput( const std::string &label );
@@ -59,8 +102,9 @@ namespace bbtk
     //==================================================================
 
     //==================================================================
-    ///  Destructor
-    virtual ~AtomicBlackBox();
+    std::string GetObjectInfo() const;      
+    size_t GetObjectSize() const;
+    size_t GetObjectRecursiveSize() const;
     //==================================================================
 
     //==================================================================
@@ -71,26 +115,13 @@ namespace bbtk
     /// Constructor from an existing box (copy) with a new instance name 
     AtomicBlackBox(AtomicBlackBox& from, const std::string &name, 
                 bool alloc = true);
-    //==================================================================
-
-  public:
-    //==================================================================   
-    /// Recursive pipeline processing in backward direction 
-    /// (recursion is in backward direction however execution always goes forward).
+    ///  Destructor
+    virtual ~AtomicBlackBox();
     /// 
-    /// \returns The final status of the box (UPTODATE or MODIFIED)
-    ///
-    /// First checks that re-processing is needed (either Status==MODIFIED or InputProcessMode==Always)
-    /// then : 
-    /// - updates its inputs by calling bbUpdateInputs (which recursively calls bbBackwardUpdate on upstream boxes)
-    /// - calls bbProcess which here simply calls the user callback bbUserProcess which does the actual processing. 
-    ///    bbProcess is overloaded in WxBlackBox to handle widget creation and show
-    virtual IOStatus bbBackwardUpdate(Connection* caller);
+    virtual void bbLockDescriptor() = 0;
     //==================================================================
 
     //==================================================================
-  protected:
-    //==================================================================
     /// Calls the user defined processing method.
     /// Overloaded in WxBlackBox to handle widget creation and show
     virtual void bbProcess() { this->bbUserProcess(); }
@@ -98,8 +129,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 '"
@@ -113,7 +144,7 @@ namespace bbtk
     /// User callback called in the box contructor
     virtual void bbUserConstructor() {}
     /// User callback called in the box copy constructor
-    virtual void bbUserCopyConstructor() {}
+    virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer) {}
     /// User callback called in the box destructor
     virtual void bbUserDestructor() {}
     //==================================================================    
@@ -126,11 +157,15 @@ namespace bbtk
     AtomicBlackBox() : BlackBox("") {}
     //================================================================== 
 
+  protected:
+    //================================================================== 
+    // The pointer on the descriptor
+    bbtk::BlackBoxDescriptor::Pointer bbmDescriptorPointer;  
+    //================================================================== 
 
   };
   // Class AtomicBlackBox
-  //===========================================================================
-
+  //====================================================================
 
 
 }