X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkAtomicBlackBox.h;h=f9d09f6ce064e3c123cc23b268c5148cdf19596f;hb=cfad95b6e08e6e53846ffcda7fbc5932065f2c47;hp=a0102bb31a98d411aed104571d12f72ed39daac5;hpb=6f678e6883d4d2734c81492412903c701c8e1f3c;p=bbtk.git diff --git a/kernel/src/bbtkAtomicBlackBox.h b/kernel/src/bbtkAtomicBlackBox.h index a0102bb..f9d09f6 100644 --- a/kernel/src/bbtkAtomicBlackBox.h +++ b/kernel/src/bbtkAtomicBlackBox.h @@ -1,25 +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/02/07 11:06:37 $ - Version: $Revision: 1.1 $ - - 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.12 $ =========================================================================*/ /** * \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 +59,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 +83,9 @@ namespace bbtk //================================================================== //================================================================== - /// Destructor - virtual ~AtomicBlackBox(); + std::string GetObjectInfo() const; + size_t GetObjectSize() const; + size_t GetObjectRecursiveSize() const; //================================================================== //================================================================== @@ -71,26 +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); - //================================================================== - - 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 amont 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 - 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 +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 '" @@ -110,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() {} - /// 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: //================================================================== @@ -126,11 +144,15 @@ namespace bbtk AtomicBlackBox() : BlackBox("") {} //================================================================== + protected: + //================================================================== + // The pointer on the descriptor + bbtk::BlackBoxDescriptor::Pointer bbmDescriptorPointer; + //================================================================== }; // Class AtomicBlackBox - //=========================================================================== - + //==================================================================== }