]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkConnection.h
=== MAJOR RELEASE ====
[bbtk.git] / kernel / src / bbtkConnection.h
index 09a5d7f0bf3f7589459823d28b15911ef77c834b..f1494f01397346cbdda5a6a6c77918efabcbdc86 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkConnection.h,v $
   Language:  C++
-  Date:      $Date: 2008/01/22 15:02:00 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2008/04/18 12:59:15 $
+  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
 #define __bbtkConnection_h__
 
 #include "bbtkSystem.h"
+#include "bbtkObject.h"
+
 #include <string>
 
 namespace bbtk
 {
+
+  class Factory;
+  BBTK_FORWARD_DECLARE_POINTER(Factory);
+  class BlackBox;
+  BBTK_FORWARD_DECLARE_POINTER(BlackBox);
+  class BlackBoxInputConnector;
+  class BlackBoxOutputConnector;
+
   /// 
   typedef int IOStatus;
   /// 
@@ -41,65 +51,87 @@ namespace bbtk
   const int UPTODATE = 1;
   /// 
   const int UPDATING = 2;
-
-
-
-  class BlackBox;
-  class BlackBoxInputConnector;
-  class BlackBoxOutputConnector;
-
 
 
-  class BBTK_EXPORT Connection
+  class BBTK_EXPORT Connection : public Object
   {
+     BBTK_OBJECT_INTERFACE(Connection);
+    typedef Object Superclass;
   public:
-    /// Ctor 
-    Connection(BlackBox* from, const std::string& output,
-              BlackBox* to, const std::string& input   );
+
+    static Pointer New(BlackBoxPointer from, const std::string& output,
+                      BlackBoxPointer to, const std::string& input,
+                      const FactoryPointer f);
     /// Dtor
-    ~Connection();
+    //    ~Connection();
 
+    // void Delete();
+    
     /// Amont direction pipeline processing
-    /// 1) call bbBackwardUpdate(this) on the amont box
-    /// 2) copies the amont box output to the aval box input adapting it if needed
+    /// 1) call bbBackwardUpdate(this) on the upstream box
+    /// 2) copies the upstream box output to the downstream box input adapting it if needed
     virtual IOStatus BackwardUpdate();
 
     /// Aval direction pipeline processing :
-    /// 1) copies the amont box output to the aval box input adapting it if needed
-    /// 2) call bbForwardUpdate(this) on the aval box
+    /// 1) copies the upstream box output to the downstream box input adapting it if needed
+    /// 2) call bbForwardUpdate(this) on the downstream box
     //    virtual void ForwardUpdate();
 
-
     virtual void SetModifiedStatus();
     std::string GetFullName() const; 
 
+    /// Returns the original initial black box of the connection
+    BlackBoxPointer GetOriginalBlackBoxFrom() const { return mOriginalFrom.lock(); }
+    /// Returns the origianl final black box of the connection
+    BlackBoxPointer GetOriginalBlackBoxTo() const { return mOriginalTo.lock(); }
+    /// Returns the original output of the initial black box of the connection
+    const std::string& GetOriginalBlackBoxFromOutput() const { return mOriginalOutput; }
+    /// Returns the original input of the final black box of the connection
+    const std::string& GetOriginalBlackBoxToInput() const { return mOriginalInput; }
+    
     /// Returns the initial black box of the connection
-    BlackBox* GetBlackBoxFrom() const { return mFrom; }
+    BlackBoxPointer GetBlackBoxFrom() const { return mFrom; }
     /// Returns the final black box of the connection
-    BlackBox* GetBlackBoxTo() const { return mTo; }
+    BlackBoxPointer GetBlackBoxTo() const { return mTo; }
     /// Returns the output of the initial black box of the connection
     const std::string& GetBlackBoxFromOutput() const { return mOutput; }
     /// Returns the input of the final black box of the connection
     const std::string& GetBlackBoxToInput() const { return mInput; }
 
+    /// Sets the initial black box of the connection
+    void SetBlackBoxFrom(BlackBoxPointer b) { mFrom = b; }
+    /// Sets the final black box of the connection
+    void SetBlackBoxTo(BlackBoxPointer b) { mTo = b; }
+    /// Sets the output of the initial black box of the connection
+    void SetBlackBoxFromOutput(const std::string& o) { mOutput = o; }
+    /// Sets the input of the final black box of the connection
+    void SetBlackBoxToInput(const std::string& o) { mInput = o; }
+
+    /// Checks that the connection is ok (throws error if not)
+    void Check() const;
     
-
   protected:
     /// Black box origin of the connection
-    BlackBox* mFrom;
+    BlackBoxPointer mFrom;
+    BlackBoxWeakPointer mOriginalFrom;
     /// Output of mFrom which is connected
     std::string mOutput;
+    std::string mOriginalOutput;
     /// Output connector of mFrom which is connected
     //  BlackBoxOutputConnector* mOutputConnector;
     /// Black box destination of the connection
-    BlackBox* mTo;
+    BlackBoxPointer mTo;
+    BlackBoxWeakPointer mOriginalTo;
     /// Input of mTo which is connected
     std::string mInput;
+    std::string mOriginalInput;
     /// Input connector of mTo which is connected
     //  BlackBoxInputConnector* mInputConnector;
     /// Adaptor black box if needed
-    BlackBox* mAdaptor;
+    BlackBoxPointer mAdaptor;
+
+    /// The factory used to create adaptors
+    const FactoryWeakPointer mFactory;
 
     /// Is the connection input type is any<thing> ?
     bool mFromAny;
@@ -111,7 +143,6 @@ namespace bbtk
     /// Have to do dynamic_cast ?
     bool mDoDynamicCast;
 
-  
     /// Ctor with the black box from and to and their input and output
     /// and a dummy int to differentiate from the public constructor.
     /// Sets the members but does not test compatibility (used by bbtk::AdaptiveConnection)
@@ -119,12 +150,16 @@ namespace bbtk
     //        BlackBox* to, const std::string& input, int   );
     
     void TransferData(); 
-  };
-
 
-}// namespace bbtk
+  private:
+    /// Ctor 
+    Connection(BlackBoxPointer from, const std::string& output,
+              BlackBoxPointer to, const std::string& input,
+              const FactoryPointer f);
 
+  };
 
+}// namespace bbtk
 
 #endif