=== MAJOR RELEASE ====

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

diff --git a/kernel/src/bbtkComplexBlackBox.h b/kernel/src/bbtkComplexBlackBox.h
index 6c041f4b117065eda8a9f2d9f105d3bdd145f517..3a5d8fb7c5ccbfdddd83c1eaa89ed9e336b21cf6 100644 (file)
--- a/kernel/src/bbtkComplexBlackBox.h
+++ b/kernel/src/bbtkComplexBlackBox.h
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkComplexBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/09 11:16:57 $
-  Version:   $Revision: 1.2 $
+  Date:      $Date: 2008/04/18 12:59:15 $
+  Version:   $Revision: 1.3 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -44,16 +44,27 @@ namespace bbtk
   //==================================================================
   class BBTK_EXPORT ComplexBlackBox : public bbtk::BlackBox
   {
+    BBTK_OBJECT_INTERFACE(ComplexBlackBox);
     friend class ComplexBlackBoxDescriptor;
+    typedef BlackBox Superclass;
   public: 
     //==================================================================
     // PUBLIC PART : ACCESSIBLE TO THE END-USER
     /// Returns the pointer on the box' descriptor
-    BlackBoxDescriptor* bbGetDescriptor() const { return mDescriptor; }
+    BlackBoxDescriptor::Pointer bbGetDescriptor() const { return mDescriptor.lock(); }
     /// Returns a pointer on a new instance with name <name>
     //BlackBox* bbNew(const std::string& name);
     /// Returns a pointer on a clone of the box with name <name>
-    BlackBox* bbClone(const std::string& name);
+    BlackBox::Pointer bbClone(const std::string& name);
+
+    /// Clear
+    void Clear();
+    /// Set as prototype
+    void SetAsPrototype() { mLockedDescriptor.reset(); }
+    /// Returns true if it is a prototype 
+    bool IsAPrototype() const { return (!mLockedDescriptor); }
+
+    std::string bbGetNameWithParent() const;
 
     void bbExecute(bool force = false);
   
@@ -67,16 +78,18 @@ namespace bbtk
                                      bool setModified = true);
 
      /// Connects the input <name> to the connection c
-    virtual void bbConnectInput( const std::string& name, Connection* c);
+    virtual void bbConnectInput( const std::string& name, 
+                                Connection::Pointer c);
     /// Connects the output <name> to the connection c
-    virtual void bbConnectOutput( const std::string& name, Connection* c);
+    virtual void bbConnectOutput( const std::string& name, 
+                                 Connection::Pointer c);
 
-    BlackBox* bbGetBlackBox( const std::string& name );
+    BlackBox::Pointer bbGetBlackBox( const std::string& name );
+
+    /// The type of map of black boxes
+    typedef std::map<std::string, BlackBox::Pointer> BlackBoxMapType;
 
-    const std::map<std::string, BlackBox*>& bbGetBlackBoxMap() 
-    { 
-      return mBlackBoxMap;
-    }
+    const BlackBoxMapType& bbGetBlackBoxMap() { return mBlackBoxMap; }
 
     void bbPrintBlackBoxes();
 
@@ -98,7 +111,7 @@ namespace bbtk
     /// Generates own description and recursively calls itself 
     /// on internal boxes with level-1 
     virtual void bbWriteDotFileBlackBox(FILE *ff,
-                                       BlackBox *parentblackbox, 
+                                       BlackBox::Pointer parentblackbox, 
                                        int detail, int level,
                                        bool instanceOrtype,
                                        bool relative_link );
@@ -107,24 +120,29 @@ namespace bbtk
                                           bool inputoutput, 
                                           int detail, int level);
     
-    virtual BlackBox *bbFindBlackBox(const std::string &blackboxname);
+    virtual BlackBox::Pointer bbFindBlackBox(const std::string &blackboxname);
     
 
     void Check(bool recursive=true);
 
+       
+
   protected:
     //==================================================================
     // PROTECTED PART : ACCESSIBLE TO ComplexBlackBoxDescriptor
+    static ComplexBlackBox::Pointer 
+    New(const std::string &name,
+       ComplexBlackBoxDescriptor::Pointer desc);
+                                
+  private:                      
     ///  Constructor that takes the ComplexBlackBox name
-    ComplexBlackBox(const std::string &name, ComplexBlackBoxDescriptor* desc);
+    ComplexBlackBox(const std::string &name,
+                   ComplexBlackBoxDescriptor::Pointer desc);
     /// Constructor from an existing box (copy) with a new name 
     ComplexBlackBox(ComplexBlackBox& from, const std::string &name);
-    // 
-   ~ComplexBlackBox();
-
     
   public:
-    IOStatus bbBackwardUpdate(Connection* caller);
+    IOStatus bbBackwardUpdate(Connection::Pointer caller);
     //  void bbForwardUpdate(Connection* caller);
     void bbSetModifiedStatus(BlackBoxInputConnector* c);
 
@@ -132,15 +150,16 @@ namespace bbtk
   
 
 
-    void bbAddBlackBox( BlackBox* );
+    void bbAddBlackBox( BlackBox::Pointer );
     void bbAddToExecutionList( const std::string& name );
-    void bbUnsafeAddBlackBox( BlackBox* );
-    void bbRemoveBlackBox( const std::string& name );
-    void bbAddConnection( Connection* );
+    void bbUnsafeAddBlackBox( BlackBox::Pointer );
+    void bbRemoveBlackBox( const std::string& name, 
+                          bool remove_connections = true);
+    void bbAddConnection( Connection::Pointer );
     
     //    void RemoveConnection( );
 
-    BlackBox* bbUnsafeGetBlackBox( const std::string& name );
+    BlackBox::Pointer bbUnsafeGetBlackBox( const std::string& name );
 
     /// 
     void bbAllocateConnectors();
@@ -151,19 +170,22 @@ namespace bbtk
     // PRIVATE PART : MEMBERS AND USEFULL INTERNAL METHODS
 
     /// Default constructor : derived classes must use the constructor with the ComplexBlackBox's name
-    ComplexBlackBox() : BlackBox("") {}
+    //ComplexBlackBox() : BlackBox("") {}
     
+    // true if the box is a prototype of a ComplexBlackBoxDescriptor
+    //    bool mIsAPrototype;
+
+    /// The descriptor pointer : is 0 if the box is a prototype 
+    ComplexBlackBoxDescriptor::Pointer mLockedDescriptor;
     /// The descriptor pointer
-    ComplexBlackBoxDescriptor* mDescriptor;
+    ComplexBlackBoxDescriptor::WeakPointer mDescriptor;
     
-    /// The type of map of black boxes
-    typedef std::map<std::string, BlackBox*> BlackBoxMapType;
     /// The map of black boxes
     BlackBoxMapType mBlackBoxMap;
     
     
     /// The type of list of connections
-    typedef std::list<Connection*> ConnectionListType;
+    typedef std::list<Connection::Pointer> ConnectionListType;
     /// The list of connections
     ConnectionListType mConnectionList;