bbtkConnection.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkConnection.h,v $
  Language:  C++
  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.
* ------------------------------------------------------------------------ */                                                                         

#ifndef __bbtkConnection_h__
#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 unsigned char IOStatus;
  const IOStatus UPTODATE  = 0;
  const IOStatus MODIFIED  = 1;
  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:

    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);
    //    ~Connection();

    // void Delete();
    
    void RecursiveExecute();
    
    void OnOutputChange(BlackBoxPointer, const std::string&, 
                        IOStatus);

    std::string GetFullName() const; 

    BlackBoxPointer GetOriginalBlackBoxFrom() const { return mOriginalFrom.lock(); }
    BlackBoxPointer GetOriginalBlackBoxTo() const { return mOriginalTo.lock(); }
    const std::string& GetOriginalBlackBoxFromOutput() const { return mOriginalOutput; }
    const std::string& GetOriginalBlackBoxToInput() const { return mOriginalInput; }
    
    BlackBoxPointer GetBlackBoxFrom() const { return mFrom; }
    BlackBoxPointer GetBlackBoxTo() const { return mTo; }
    const std::string& GetBlackBoxFromOutput() const { return mOutput; }
    const std::string& GetBlackBoxToInput() const { return mInput; }

    void SetBlackBoxFrom(BlackBoxPointer b) { mFrom = b; }
    void SetBlackBoxTo(BlackBoxPointer b) { mTo = b; }
    void SetBlackBoxFromOutput(const std::string& o) { mOutput = o; }
    void SetBlackBoxToInput(const std::string& o) { mInput = o; }

    void Check() const;
    
  protected:
    BlackBoxPointer mFrom;
    BlackBoxWeakPointer mOriginalFrom;
    std::string mOutput;
    std::string mOriginalOutput;
    //  BlackBoxOutputConnector* mOutputConnector;
    BlackBoxPointer mTo;
    BlackBoxWeakPointer mOriginalTo;
    std::string mInput;
    std::string mOriginalInput;
    //  BlackBoxInputConnector* mInputConnector;
    BlackBoxPointer mAdaptor;

    const FactoryWeakPointer mFactory;

    bool mFromAny;

    bool mToAny;


    bool mDoDynamicCast;

    //  Connection(BlackBox* from, const std::string& output,
    //         BlackBox* to, const std::string& input, int   );
  public:   
    void TransferData(); 

  private:
    Connection(BlackBoxPointer from, const std::string& output,
               BlackBoxPointer to, const std::string& input,
               const FactoryPointer f);
    Connection(BlackBoxPointer from, const std::string& output,
               BlackBoxPointer to, const std::string& input);

  };

}// namespace bbtk

#endif