/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkAtomicBlackBox.cxx,v $
  Language:  C++
  Date:      $Date: 2008/12/08 12:53:35 $
  Version:   $Revision: 1.11 $
=========================================================================*/

/* ---------------------------------------------------------------------

* 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::AtomicBlackBox : abstract user defined black boxes
 */
#include "bbtkAtomicBlackBox.h"

namespace bbtk
{
  
  //=========================================================================
  AtomicBlackBox::AtomicBlackBox(const std::string &name, bool alloc)
    : BlackBox(name)
  {
    bbtkDebugMessage("object",3,
		     "==> AtomicBlackBox::AtomicBlackBox(\""
		     <<name<<"\")"<<std::endl);
    bbtkDebugMessage("object",3,
		     "<== AtomicBlackBox::AtomicBlackBox(\""
		     <<name<<"\")"<<std::endl);
  }
  //========================================================================= 
  
  //=========================================================================
  /// Constructor from an existing box (copy) with a new name 
  AtomicBlackBox::AtomicBlackBox(AtomicBlackBox& from, 
                const std::string &name, 
                bool alloc)
    : BlackBox(from,name)
  {
    bbtkDebugMessage("object",3,
		     "==>AtomicBlackBox::AtomicBlackBox("
		     <<from.bbGetFullName()<<",\""
		     <<name<<"\")"<<std::endl);
    bbtkDebugMessage("object",3,
		     "<==AtomicBlackBox::AtomicBlackBox("
		     <<from.bbGetFullName()<<",\""
		     <<name<<"\")"<<std::endl);
    
  }
  //=========================================================================
  
  
  //=========================================================================
  ///  Destructor
  AtomicBlackBox::~AtomicBlackBox()
  {
    bbtkDebugMessage("object",3,"==> AtomicBlackBox::~AtomicBlackBox()"
		     <<std::endl);
    bbtkDebugMessage("object",3,"<== AtomicBlackBox::~AtomicBlackBox()"
		     <<std::endl);
  } 
  //=========================================================================
  


  //=========================================================================
  /// Main processing method of the box.
  void AtomicBlackBox::bbBackwardUpdate( Connection::Pointer caller )
  {
    bbtkDebugMessageInc("process",3,
			"=> AtomicBlackBox::bbBackwardUpdate("
			<<(caller?caller->GetFullName():"0")<<") ["
			<<bbGetFullName()<<"]"<<std::endl);

    // If already executing : return
    if (bbGetExecuting()) 
      {
	bbtkDebugMessage("process",3,
			 " -> already executing : returning"<<std::endl);
	return; 
      }

    bbSetExecuting(true);
    bool wasExecuting = bbGlobalGetSomeBoxExecuting();
    bbGlobalSetSomeBoxExecuting(true);

    // Updates its inputs
    IOStatus s = bbUpdateInputs();
    
    if ( (s != UPTODATE) ||
	 bbBoxProcessModeIsAlways() )
      {
	// User process
	bbProcess();
	
	// Displays the window (WxBlackbox)
	bbShowWindow(caller);
	
	// Update the I/O statuses
	bbComputePostProcessStatus();
      }
    else 
      {
        bbtkDebugMessage("process",5," -> Up-to-date : nothing to do"
			 <<std::endl);
      }

    bbtkDebugMessage("process",3,
            "<= AtomicBlackBox::bbBackwardUpdate() ["
            <<bbGetFullName()<<"]"<<std::endl);

    bbSetExecuting(false);
    bbGlobalSetSomeBoxExecuting(wasExecuting);

    return; // bbGetStatus();

  }
  //=========================================================================
  
    
  //=========================================================================
  Data AtomicBlackBox::bbGetOutput( const std::string &name )
  {
    bbtkDebugMessageInc("Data",7,
            "AtomicBlackBox::bbGetOutput(\""<<name<<"\") ["
            <<bbGetFullName()<<"]"
            <<std::endl);
    
    Data p = ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()
                ->GetOutputDescriptor(name))->GetGetFunctor()->Get(this);
    
    bbtkDebugDecTab("Data",7);
    return p;
  }
  //=========================================================================
  
  
  //=========================================================================
  ///  Gets the input Data of a given name
  Data AtomicBlackBox::bbGetInput( const std::string &name ) 
  {
    bbtkDebugMessageInc("Data",7,
            "AtomicBlackBox::bbGetInput(\""<<name<<"\") ["
            <<bbGetFullName()<<"]"
            <<std::endl);  
    
    Data p = ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()
                ->GetInputDescriptor(name))->GetGetFunctor()->Get(this);
    
    bbtkDebugDecTab("Data",7);
    return p;
  }
  //=========================================================================
  
  
  //=========================================================================
  ///  Sets the data of the output called <name>
  void AtomicBlackBox::bbSetOutput( const std::string &name, Data data)
  {
    bbtkDebugMessageInc("Data",7,
            "AtomicBlackBox::bbSetOutput(\""<<name<<"\",data) ["
            <<bbGetFullName()<<"]"
            <<std::endl); 
    
    ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()
        ->GetOutputDescriptor(name))->GetSetFunctor()->Set(this,data);
    
    bbtkDebugDecTab("Data",7);
  }  
  //=========================================================================
  
  
  //=========================================================================
  ///  Sets the data of the input called <name>
  void AtomicBlackBox::bbSetInput(const std::string &name,
				  Data data, 
				  bool setModified )
  {
    bbtkDebugMessageInc("data",7,
            "AtomicBlackBox::bbSetInput(\""<<name<<"\",data) ["
            <<bbGetFullName()<<"]"
            <<std::endl);  
    ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->Set(this,data);
    
    if (setModified) 
      {
	bbSetStatusAndPropagate(bbGetInputConnectorMap().find(name)->second,
				MODIFIED);
      }
    
    bbtkDebugDecTab("data",7);
  }
  //=========================================================================
  
  //=========================================================================
  ///  Sets the data of the input called <name>
  void AtomicBlackBox::bbBruteForceSetInputPointer(const std::string &name, 
						   void* data, 
						   bool setModified
						   )
  {
    bbtkDebugMessageInc("data",7,
            "AtomicBlackBox::bbBruteForceSetInputPointer(\""
            <<name<<"\",data) ["
            <<bbGetFullName()<<"]"
            <<std::endl);  
    ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()
        ->GetInputDescriptor(name))->GetSetFunctor()
            ->BruteForceSetPointer(this,data);
    
    if (setModified) 
      {
	bbSetStatusAndPropagate(bbGetInputConnectorMap().find(name)->second,
				MODIFIED);
      }
    
    bbtkDebugDecTab("data",7);
  }
  //=========================================================================
 


  //==========================================================================
  std::string AtomicBlackBox::GetObjectInfo() const 
  {
    std::stringstream i;
    return i.str();
  }
  //==========================================================================

  //==========================================================================
  size_t AtomicBlackBox::GetObjectSize() const 
  {
    return sizeof(*this);
  }
  //==========================================================================
  
  //==========================================================================
  size_t AtomicBlackBox::GetObjectRecursiveSize() const 
  {
    size_t s = GetObjectSize();
    return s;
  }
  //==========================================================================

 
}
// EO namespace bbtk