/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkBlackBoxInputConnector.h,v $
  Language:  C++
  Date:      $Date: 2008/04/18 12:59:15 $
  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.
                                                                                
=========================================================================*/

/**
 *  \file 
 *  \brief Class bbtk::BlackBoxInputConnector : 
 */
/**
 * \class bbtk::BlackBoxInputConnector
 * \brief 
 */
 
#ifndef __bbtkBlackBoxInputConnector_h__
#define __bbtkBlackBoxInputConnector_h__

#include "bbtkConnection.h"
#include <vector>

namespace bbtk
{

  class BlackBox;
  BBTK_FORWARD_DECLARE_POINTER(BlackBox);

  class BBTK_EXPORT BlackBoxInputConnector 
  {
  public:
     
    /// Ctor
    BlackBoxInputConnector(BlackBoxPointer b);
    /// Dtor
    ~BlackBoxInputConnector();    
    /// Sets a connection
    void SetConnection(Connection::Pointer c);
    /// Unsets the connection 
    /// The parameter is USELESS today but would be useful if we allow multiple connections on inputs
    void UnsetConnection(Connection::Pointer c);
  
    IOStatus BackwardUpdate();

    /// Returns the connection plugged into this input (const)
    Connection::Pointer GetConnection() const { return mConnection.lock(); }
    /// Returns true iff a connection is connected to it
    bool IsConnected() const { return (mConnection.lock() != 0); }
    /// Returns the status of the input (UPTODATE | MODIFIED)
    const IOStatus& GetStatus() const { return mStatus; }
    ///
    BlackBoxPointer GetBlackBox() const { return mBox.lock(); } 
  private:
    /// 
    BlackBoxWeakPointer mBox;
    /// The connection plugged into the input
    Connection::WeakPointer mConnection;
    /// The status of the input (UPTODATE | MODIFIED)
    IOStatus mStatus;
  };
  
}
// namespace bbtk
#endif