2397 BBTK Feature New Normal Feature GetBoxesInside for showing the tree of a blackbo...

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

diff --git a/kernel/src/bbtkBlackBoxDescriptor.h b/kernel/src/bbtkBlackBoxDescriptor.h
index d826882c5664ca9441f4cff8336492759d0edfd6..8124b35a10689f9c97d0cb3ccf3aad4108d38996 100644 (file)
--- a/kernel/src/bbtkBlackBoxDescriptor.h
+++ b/kernel/src/bbtkBlackBoxDescriptor.h
@@ -1,21 +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: bbtkBlackBoxDescriptor.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/22 06:59:31 $
-  Version:   $Revision: 1.10 $
-                                                                                
-  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.13 $
 =========================================================================*/
 
+
 /**
  *  \file 
  *  \brief Class bbtk::BlackBoxDescriptor : (abstract) describes of a BlackBox (name, description, author) and is able to create an instance of it.
@@ -33,7 +51,7 @@
 #include "bbtkBlackBoxOutputDescriptor.h"
 #include <map>
 #include <fstream>
-
+#include "bbtkUtilities.h"
 namespace bbtk
 {
 
@@ -66,6 +84,13 @@ namespace bbtk
     }
     Kind;
 
+       typedef enum
+       {
+               TS_BINARY=0,
+               TS_SCRIPT_COMPLEXBOX=1,
+               TS_SCRIPT_APPLICATION=2
+       } TypeOfScript;
+         
     /// Releases a descriptor
     //    static void Release(BlackBoxDescriptor::WeakPointer);
 
@@ -145,6 +170,35 @@ namespace bbtk
     ///
     virtual void Check(bool recursive=true) const;
 
+         virtual void GetBoxesInside (NodeTreeC& tree, int cont);
+         
+         /// Sets the name of the script file from which it is defined
+         void SetScriptFileName(const std::string& n) { mScriptFileName = n; }
+         /// Gets the name of the script file from which it is defined
+         std::string GetScriptFileName() const { return mScriptFileName; }
+         
+         
+         
+         
+         /// Gets the type of script  BINARY, SCRIPT_COMPLEXBOX, SCRIPT_APPLICATION 
+         TypeOfScript GetTypeOfScript()                        {       return mTypeOfScript;   };
+         void SetTypeOfScript(TypeOfScript type)       {       mTypeOfScript=type;             };        
+         bool IsTypeOfScript_Application();
+         bool IsTypeOfScript_ComplexBox();
+         void SetTypeOfScript_Application();
+         
+         
+         
+         
+  private:
+         
+         TypeOfScript mTypeOfScript;
+         
+         /// The name of the script file from which it was created
+         std::string mScriptFileName;
+         
+         
+         
   protected:
     /// Adds an input descriptor
     void AddInputDescriptor( BlackBoxInputDescriptor *d )