/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkAtomicBlackBox.cxx,v $
  Language:  C++
  Date:      $Date: 2008/04/18 12:59:14 $
  Version:   $Revision: 1.4 $
                                                                                
  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::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.
  IOStatus AtomicBlackBox::bbBackwardUpdate( Connection::Pointer caller )
  {
    bbtkDebugMessageInc("Process",1,
			"=> AtomicBlackBox::bbBackwardUpdate("
			<<(caller?caller->GetFullName():"0")<<") ["
			<<bbGetFullName()<<"]"<<std::endl);
    
    if (bbGetExecuting()) 
      {
	bbtkWarning(bbGetFullName()<<" : Cyclic execution stopped");
	return UPTODATE;
      }
    bbSetExecuting(true);

    bbtkDebugMessage("Process",5,"Initial Status  = "<<bbGetStatus()
                    <<std::endl);
    bbtkDebugMessage("Process",5,"BoxProcessMode  = "
                    <<bbGetInputBoxProcessMode()<<std::endl);
   
    /* 
    if ( bbGetStatus() == UPDATING ) 
      {
    bbtkMessage("Warning",1,"!! WARNING !! Cyclic pipeline execution (bbBackwardUpdate ["<<bbGetFullName()<<"] reentered). This may indicate an error in pipeline conception"<<std::endl);
    //	return UPTODATE;
    bbSetStatus(MODIFIED);
      }
    */

    if ( ( bbGetStatus() == MODIFIED ) ||
        ( bbBoxProcessModeIsAlways() ) )
      {
        bool wasExecuting = bbGlobalGetSomeBoxExecuting();
        bbGlobalSetSomeBoxExecuting(true);

        //	bbSetStatus(UPDATING);

        // Updates its inputs
        IOStatus s = bbUpdateInputs();
    
        bbtkDebugMessage("Process",6,"Inputs post-update status = "<<s<<std::endl);
        // If all inputs are in UPTODATE post-update status 
        // and mProcessMode is not "Always"
        // then the box is now UPTODATE
        if ( ( s == UPTODATE ) && 
            ( ! bbBoxProcessModeIsAlways() ) ) 
            {
                bbSetStatus(UPTODATE);
            }
        else 
            {
                // else it remains MODIFIED
                bbSetStatus(MODIFIED);
            }

        // User process
        bbProcess();

        // Displays the window (WxBlackbox)
        bbShowWindow(caller);

        bbGlobalSetSomeBoxExecuting(wasExecuting);

      }
    else 
      {
        bbtkDebugMessage("Process",5,"Up-to-date : nothing to do"<<std::endl);
      }

    bbtkDebugMessage("Process",5,"Final Status    = "
            <<bbGetStatus()<<std::endl);
    bbtkDebugMessage("Process",1,
            "<= AtomicBlackBox::bbBackwardUpdate() ["
            <<bbGetFullName()<<"]"<<std::endl);
    bbtkDebugDecTab("Process",1);

    bbSetExecuting(false);

    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) 
        {
            bbSetModifiedStatus();
        }
    
    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) 
      {
        bbSetModifiedStatus();
      }
    
    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