-/*=========================================================================
-
+/*=========================================================================
Program: bbtk
Module: $RCSfile: bbtkComplexBlackBoxDescriptor.h,v $
Language: C++
- Date: $Date: 2008/04/09 11:16:57 $
- Version: $Revision: 1.4 $
-
- 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/10/17 08:18:12 $
+ Version: $Revision: 1.6 $
=========================================================================*/
+/* ---------------------------------------------------------------------
+
+* 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.
{
class ComplexBlackBox;
-
+ typedef boost::shared_ptr<ComplexBlackBox> ComplexBlackBoxPointer;
+
//==========================================================================
- class BBTK_EXPORT ComplexBlackBoxDescriptor : public bbtk::BlackBoxDescriptor
+ class BBTK_EXPORT ComplexBlackBoxDescriptor :
+ public bbtk::BlackBoxDescriptor
{
+ BBTK_OBJECT_INTERFACE(ComplexBlackBoxDescriptor);
+ typedef BlackBoxDescriptor Superclass;
public:
friend class ComplexBlackBox;
- /// Default ctor with name
- ComplexBlackBoxDescriptor(const std::string& name);
- protected:
- /// Default dtor
- ~ComplexBlackBoxDescriptor();
- public:
+
+ static Pointer New(const std::string& name);
/// Sets the factory used
- void SetFactory(Factory* f) { mFactory = f; }
+ void SetFactory(Factory::Pointer f) { mFactory = f; }
/// Gets the factory used
- Factory* GetFactory() { return mFactory; }
+ Factory::Pointer GetFactory() const { return mFactory.lock(); }
+
+ /// Releases the descriptor
+ // void Release(bool release_package = true);
+
/// Gets the factory used (const)
- const Factory* GetFactory() const { return mFactory; }
+ // const Factory* GetFactory() const { return mFactory; }
/// Creates an instance of name <name> of the ComplexBlackBox of which this is the descriptor
- virtual BlackBox* CreateInstance(const std::string& name);
+ virtual BlackBoxPointer NewBlackBox(const std::string& name);
/// Adds a black box to the complex box
/// Needs a factory set !
void Add ( const std::string& type,
const std::string& name
);
+
+ /// Removes a black box from the complex box
+ void Remove( const std::string& name, bool remove_connections = true);
+
/// Connects two black boxes of the complex box
/// Needs a factory set !
void Connect ( const std::string& from,
///
void AddToExecutionList( const std::string& box );
- ComplexBlackBox* GetPrototype() { return mPrototype; }
+ ComplexBlackBoxPointer GetPrototype() { return mPrototype; }
void PrintBlackBoxes();
/// Prints help on the black box
///
virtual void Check(bool recursive=true) const;
+
+
+
+ protected:
+ /// Default ctor with name is protected
+ ComplexBlackBoxDescriptor(const std::string& name);
private:
- /// Default ctor is private (must have name and factory)
- ComplexBlackBoxDescriptor() {}
/// The factory used
- Factory* mFactory;
+ Factory::WeakPointer mFactory;
/// The complex box in which boxes and connections are stored
- ComplexBlackBox* mPrototype;
+ ComplexBlackBoxPointer mPrototype;
/// The name of the script file from which it was created
std::string mScriptFileName;