X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkTranscriptor.h;h=9418c7e6f32e3c4c2df0661eca4b21da57976142;hb=de86b2c1152e6932fd8d846702aa5a72b81ded5c;hp=60b051b227c2c9c868add8b5cda347e0b939f5ee;hpb=7df8c08153bd03b58bf320982ec5715122f12eea;p=bbtk.git diff --git a/kernel/src/bbtkTranscriptor.h b/kernel/src/bbtkTranscriptor.h index 60b051b..9418c7e 100644 --- a/kernel/src/bbtkTranscriptor.h +++ b/kernel/src/bbtkTranscriptor.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: bbtkTranscriptor.h,v $ $ + Module: $RCSfile: bbtkTranscriptor.h,v $ Language: C++ - Date: $Date: 2008/10/02 07:43:21 $ - Version: $Revision: 1.11 $ - - 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.16 $ =========================================================================*/ + + + /** * \file * \brief class Transcriptor: level 0 of script C++ translation (header) @@ -94,6 +114,8 @@ namespace bbtk /// (Used to set it after the Define command) void SetCurrentFileName (const std::string &name ); + void SetTypeOfScript_Application(); + /// End the definition of a ComplexBlackBox void EndDefine (); @@ -106,6 +128,9 @@ namespace bbtk /// Destroys a black box void Destroy (const std::string &boxName); + /// Clears the currently defined ComplexBlackBox + void Clear(); + /// Connects the output boxOutput to the input boxInput void Connect (const std::string &boxfrom, const std::string &output, @@ -149,7 +174,7 @@ namespace bbtk void Description(const std::string & d); /// prints the list off the boxes of the current box - void PrintBoxes(); + void PrintHelpListBoxes(); /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraph(const std::string &nameblackbox, @@ -163,8 +188,8 @@ namespace bbtk /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true); - /// Description of the actual pipeline - void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + /// Prints help on a black box + void PrintHelpBlackBox(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); void Reset();