X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkConnection.h;h=36b20b8a39b0310d34342e99372093e2198c7f3b;hb=ab0cfcfdd031ff179ed1550874c648a54d8e1023;hp=4a7996844034dea487967bf1664fa49849fc9b6d;hpb=3fb0c5f4f00f86519c93413ab2386c47c5224345;p=bbtk.git diff --git a/kernel/src/bbtkConnection.h b/kernel/src/bbtkConnection.h index 4a79968..36b20b8 100644 --- a/kernel/src/bbtkConnection.h +++ b/kernel/src/bbtkConnection.h @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkConnection.h,v $ Language: C++ - Date: $Date: 2008/02/20 16:05:38 $ - Version: $Revision: 1.2 $ - - 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/04/21 14:36:51 $ + Version: $Revision: 1.13 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* 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::Connection @@ -29,69 +42,114 @@ #define __bbtkConnection_h__ #include "bbtkSystem.h" +#include "bbtkObject.h" + #include namespace bbtk { - /// - typedef int IOStatus; - /// - const int MODIFIED = 0; - /// - const int UPTODATE = 1; - /// - const int UPDATING = 2; + class Factory; + BBTK_FORWARD_DECLARE_POINTER(Factory); class BlackBox; + BBTK_FORWARD_DECLARE_POINTER(BlackBox); class BlackBoxInputConnector; class BlackBoxOutputConnector; - class BBTK_EXPORT Connection + /// The type of input / output status + typedef unsigned char IOStatus; + /// Up-to-date status value + const IOStatus UPTODATE = 0; + /// Modified status value + const IOStatus MODIFIED = 1; + /// Out-of-date status value + const IOStatus OUTOFDATE = 2; + + BBTK_EXPORT const std::string& GetIOStatusString( IOStatus ); + + + 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 ); - /// Dtor - ~Connection(); - /// Amont direction pipeline processing - /// 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(); + static Pointer New(BlackBoxPointer from, const std::string& output, + BlackBoxPointer to, const std::string& input, + const FactoryPointer f); + static Pointer New(BlackBoxPointer from, const std::string& output, + BlackBoxPointer to, const std::string& input); + /// Dtor + // ~Connection(); - /// Aval direction pipeline processing : - /// 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(); + // void Delete(); + + /// Pipeline processing method + /// 1) call bbRecursiveExecute(this) on the from box + /// 2) copies the from box output to the to box input + /// adapting it if needed + /// 3) sets the new IOStatus of the to box input to the + /// status of the from box output + void RecursiveExecute(); + + /// Change callback + void OnOutputChange(BlackBoxPointer, const std::string&, + IOStatus); - 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 ? bool mFromAny; @@ -108,8 +166,18 @@ namespace bbtk /// Sets the members but does not test compatibility (used by bbtk::AdaptiveConnection) // Connection(BlackBox* from, const std::string& output, // BlackBox* to, const std::string& input, int ); - + public: void TransferData(); + + private: + /// Ctor + Connection(BlackBoxPointer from, const std::string& output, + BlackBoxPointer to, const std::string& input, + const FactoryPointer f); + /// Ctor + Connection(BlackBoxPointer from, const std::string& output, + BlackBoxPointer to, const std::string& input); + }; }// namespace bbtk