X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkComplexBlackBoxDescriptor.cxx;h=a56659c030cb2b2572bd4dfe8fbe49544efa6401;hb=63d56e2f28b834d9e13f3757aaa23ab63b2b3dd6;hp=70fc8c7a2d619b298c21044a2a40d65074c8b007;hpb=0500d9322df28ddf952e0082d5da47b7a8b69a07;p=bbtk.git diff --git a/kernel/src/bbtkComplexBlackBoxDescriptor.cxx b/kernel/src/bbtkComplexBlackBoxDescriptor.cxx index 70fc8c7..a56659c 100644 --- a/kernel/src/bbtkComplexBlackBoxDescriptor.cxx +++ b/kernel/src/bbtkComplexBlackBoxDescriptor.cxx @@ -1,21 +1,34 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkComplexBlackBoxDescriptor.cxx,v $ Language: C++ - Date: $Date: 2008/02/06 14:58:41 $ - Version: $Revision: 1.6 $ - - 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: 2009/05/28 08:12:05 $ + Version: $Revision: 1.20 $ =========================================================================*/ +/* --------------------------------------------------------------------- + +* 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::ComplexBlackBoxDescriptor : describes a ComplexBlackBox (constituents, connections) and is able to create an instance of it. @@ -26,20 +39,37 @@ #include "bbtkMessageManager.h" #include "bbtkUtilities.h" +#define bbtkDMessage(key,level,mess) \ + bbtkMessage(key,level,"["< ComplexBlackBoxDescriptor::New(\""< ComplexBlackBoxDescriptor(\""<SetAsPrototype(); + bbtkDDebugMessage("object",2,"<== ComplexBlackBoxDescriptor(\""< ~ComplexBlackBoxDescriptor()"<Check(recursive); + } + //========================================================================= //======================================================================= /// Creates an instance of name of the ComplexBlackBox of which this is the descriptor - BlackBox* ComplexBlackBoxDescriptor::CreateInstance(const std::string& name) + BlackBox::Pointer + ComplexBlackBoxDescriptor::NewBlackBox(const std::string& name) { - //bbtkError("ComplexBlackBoxDescriptor::CreateInstance not implemented"); - bbtkDebugMessageInc("Kernel",5, - "ComplexBlackBoxDescriptor::CreateInstance(\"" - <bbClone(name); - bbtkDebugDecTab("Kernel",5); + } //======================================================================= - + /* + //======================================================================= + /// Release + void ComplexBlackBoxDescriptor::Release(bool release_package) + { + } + //======================================================================= + */ //======================================================================= /// Adds a black box to the complex box @@ -82,11 +124,16 @@ namespace bbtk const std::string& name ) { - bbtkDebugMessageInc("Kernel",5, + bbtkDDebugMessage("kernel",5, "ComplexBlackBoxDescriptor::Add(\"" - <bbUnsafeGetBlackBox( name ) ) @@ -94,22 +141,32 @@ namespace bbtk bbtkError("a black box \""<bbAddBlackBox ( /*mFactory->Create*/ NewBlackBox(type,name) ); + mPrototype->bbAddBlackBox ( GetFactory()->NewBlackBox(type,name) ); + - bbtkDebugDecTab("Kernel",5); } //======================================================================= + + //======================================================================= + /// Removes a black box from the complex box + void ComplexBlackBoxDescriptor::Remove( const std::string& name, + bool remove_connections) + { + mPrototype->bbRemoveBlackBox(name,remove_connections); + } + //======================================================================= + - //======================================================================= + //======================================================================= /// Adds a black box to the execution list void ComplexBlackBoxDescriptor::AddToExecutionList ( const std::string& box) { - bbtkDebugMessageInc("Kernel",5, - "ComplexBlackBoxDescriptor::AddToExecutionList(\"" - <bbUnsafeGetBlackBox( box ); + BlackBox::Pointer b = mPrototype->bbUnsafeGetBlackBox( box ); if ( !b ) { bbtkError("the black box \""<bbAddToExecutionList ( box ); - bbtkDebugDecTab("Kernel",5); + } @@ -129,29 +186,37 @@ namespace bbtk const std::string& input ) { - bbtkDebugMessageInc("Kernel",5, + bbtkDDebugMessage("kernel",5, "ComplexBlackBoxDescriptor::Connect(\"" <bbGetBlackBox( from ); + BlackBox::Pointer bbfrom = mPrototype->bbGetBlackBox( from ); if ( !bbfrom ) { bbtkError("the black box \""<bbGetBlackBox( to ); + BlackBox::Pointer bbto = mPrototype->bbGetBlackBox( to ); if ( !bbto ) { bbtkError("the black box \""<*/ NewConnection( bbfrom, output, bbto, input ); + Connection::Pointer c + = GetFactory()->NewConnection( bbfrom, output, bbto, input ); mPrototype->bbAddConnection(c); - bbtkDebugDecTab("Kernel",5); + } //======================================================================= @@ -163,14 +228,14 @@ namespace bbtk const std::string& input, const std::string& help) { - bbtkDebugMessageInc("Kernel",5, + bbtkDDebugMessage("kernel",5, "ComplexBlackBoxDescriptor::DefineInput(\"" <bbGetBlackBox( box ); + BlackBox::Pointer bb = mPrototype->bbGetBlackBox( box ); if ( !bb ) { bbtkError("the black box \""<bbGetDescriptor()->GetInputDescriptor(input); AddInputDescriptor ( new ComplexBlackBoxInputDescriptor ( typeid(ComplexBlackBoxDescriptor), name, help, + d->GetNature(), box, input, - bb->bbGetInputType(input))); + d->GetTypeInfo())); - bbtkDebugDecTab("Kernel",5); + } //======================================================================= @@ -202,14 +270,14 @@ namespace bbtk const std::string& output, const std::string& help) { - bbtkDebugMessageInc("Kernel",5, + bbtkDDebugMessage("kernel",5, "ComplexBlackBoxDescriptor::DefineOutput(\"" <bbGetBlackBox( box ); + BlackBox::Pointer bb = mPrototype->bbGetBlackBox( box ); if ( !bb ) { bbtkError("the black box \""<bbGetDescriptor()->GetOutputDescriptor(output); AddOutputDescriptor ( new ComplexBlackBoxOutputDescriptor ( typeid(ComplexBlackBoxDescriptor), name, help, + d->GetNature(), box, output, - bb->bbGetOutputType(output))); + d->GetTypeInfo())); - bbtkDebugDecTab("Kernel",5); + } //======================================================================= @@ -260,9 +331,9 @@ namespace bbtk int detail, int level, const std::string& output_dir, bool relative_link) { - bbtkDebugMessageInc("Kernel",9, - "ComplexBlackBoxDescriptor::InsertHtmlHelp() [" - < categories; + // Split the category string + std::string delimiters = ";,"; + Utilities::SplitString(GetCategory(), + delimiters,categories); + (s) << "

\n"; (s) << "\n"; - (s) << "\n"; - + (s) << "\n"; std::string inc = GetScriptFileName(); if (inc.size()>0) { - (s) << "\n"; + s << "\n"; } @@ -311,18 +394,18 @@ namespace bbtk if (B.size()) { - (s) << "\n"; - } + } // If B.size (s) << "
Description : " @@ -296,14 +371,22 @@ namespace bbtk (s) << "
Author(s) : " << author << "
Category(s) : " - << category << "
Category(s) : "; + std::vector::iterator ci; + for (ci=categories.begin(); ci!=categories.end(); ++ci) + { + s << "" << *ci + << " \n"; + } + s << "
Use command : include " - << inc << "
To use it : include "; + // s << inc << "  [source]"; + // LG TODO : USE PACKAGE BBS PATH + s << inc << "  [source]"; + s << "
Dependencies : "; + (s) << "
Uses : "; - std::set pdeps; + std::set pdeps; ComplexBlackBox::BlackBoxMapType::const_iterator b; for ( b = B.begin(); b != B.end(); ++b ) { - BlackBoxDescriptor* d = b->second->bbGetDescriptor(); + BlackBoxDescriptor::Pointer d = b->second->bbGetDescriptor(); if (pdeps.find(d) != pdeps.end()) continue; pdeps.insert(d); - Package* p = d->GetPackage(); + Package::Pointer p = d->GetPackage(); std::string name = b->second->bbGetTypeName(); @@ -331,14 +414,14 @@ namespace bbtk url = p->GetDocRelativeURL(); else url = p->GetDocURL(); - + s << "" << p->GetName()<<"::"<\n"; - } + } // for (s) << "
\n"; @@ -416,7 +499,7 @@ namespace bbtk //------------ // End - bbtkDebugDecTab("Kernel",9); + } //========================================================================= @@ -424,25 +507,28 @@ namespace bbtk //======================================================================= void ComplexBlackBoxDescriptor::GetHelp(bool full) const { - if (full) bbtkMessage("Help",1,"Complex Black Box <"<< + if (full) bbtkMessage("help",1,"Complex Black Box <"<< GetPackage()->GetName()<<"::" <"<second->GetName().size()>namelmax) namelmax = i->second->GetName().size(); if (i->second->GetTypeName().size()>typelmax) typelmax = i->second->GetTypeName().size(); + if (i->second->GetNature().size()>natlmax) + natlmax = i->second->GetNature().size(); } OutputDescriptorMapType::const_iterator o; if (full) @@ -453,6 +539,8 @@ namespace bbtk namelmax = o->second->GetName().size(); if (o->second->GetTypeName().size()>typelmax) typelmax = o->second->GetTypeName().size(); + if (o->second->GetNature().size()>natlmax) + natlmax = o->second->GetNature().size(); } } // @@ -465,17 +553,21 @@ namespace bbtk std::string type(i->second->GetTypeName()); type += ">"; type.append(1+typelmax-type.size(),' '); - bbtkMessage("Help",1, - " '"<second->GetDescription()<second->GetNature()); + nature += "]"; + nature.append(1+natlmax-nature.size(),' '); + bbtkMessage("help",1, + " '"<second->GetDescription()<second->GetName()); @@ -484,9 +576,13 @@ namespace bbtk std::string type(o->second->GetTypeName()); type += ">"; type.append(1+typelmax-type.size(),' '); - bbtkMessage("Help",1, - " '"<second->GetNature()); + nature += "]"; + nature.append(1+natlmax-nature.size(),' '); + bbtkMessage("help",1, + " '"<second->GetDescription()<bbGetBlackBoxMap(); if (B.size()) - bbtkMessage("Help",1," * Boxes : "<second->bbGetName()<< + bbtkMessage("help",1," '"<second->bbGetName()<< "' <" << b->second->bbGetDescriptor()->GetPackage()->GetName() <<"::" @@ -513,6 +609,43 @@ namespace bbtk } //======================================================================= - + //========================================================================== + std::string ComplexBlackBoxDescriptor::GetObjectName() const + { + return std::string("ComplexBlackBoxDescriptor '")+GetFullTypeName() + +std::string("'"); + } + //========================================================================== + //======================================================================= + std::string ComplexBlackBoxDescriptor::GetObjectInfo() const + { + std::string i; + return i; + } + //======================================================================= + //========================================================================== +size_t ComplexBlackBoxDescriptor::GetObjectSize() const +{ + size_t s = Superclass::GetObjectSize(); + s += ComplexBlackBoxDescriptor::GetObjectInternalSize(); + return s; + } + //========================================================================== + //========================================================================== +size_t ComplexBlackBoxDescriptor::GetObjectInternalSize() const +{ + size_t s = sizeof(ComplexBlackBoxDescriptor); + return s; + } + //========================================================================== + //========================================================================== + size_t ComplexBlackBoxDescriptor::GetObjectRecursiveSize() const + { + size_t s = Superclass::GetObjectRecursiveSize(); + s += ComplexBlackBoxDescriptor::GetObjectInternalSize(); + s += mPrototype->GetObjectRecursiveSize(); + return s; + } + //========================================================================== }