/*=========================================================================
                                                                                
  Program:   bbtk
  Module:    $RCSfile: bbtkUserBlackBox.cxx,v $
  Language:  C++
  Date:      $Date: 2008/01/22 15:02:00 $
  Version:   $Revision: 1.1.1.1 $
                                                                                
  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::UserBlackBox : abstract user defined black boxes
 */
#include "bbtkUserBlackBox.h"

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

  //=========================================================================
  /// Main processing method of the box.
  IOStatus UserBlackBox::bbBackwardUpdate( Connection* caller )
  {
    bbtkDebugMessageInc("Process",1,
			"=> UserBlackBox::bbBackwardUpdate() ["
			<<bbGetFullName()<<"]"<<std::endl);
    
    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);
	  } 	

	// Creates the window (WxBlackbox)
	//	bbCreateWindow();

	// Children update (WxContainerBlackBox)
	//	bbUpdateChildren(caller);	

	// 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,
		     "<= UserBlackBox::bbBackwardUpdate() ["
		     <<bbGetFullName()<<"]"<<std::endl);
    bbtkDebugDecTab("Process",1);

    return bbGetStatus();

  }
  //=========================================================================
  
  /*
  //=========================================================================
  /// Main processing method of the box.
  void UserBlackBox::bbForwardUpdate( Connection* caller )
  {
    bbtkDebugMessageInc("Process",1,
			"=> UserBlackBox::bbForwardUpdate() ["
			<<bbGetFullName()<<"]"<<std::endl);
    
    bbtkDebugMessage("Process",5,"Initial Status  = "<<bbGetStatus()<<std::endl);
    bbtkDebugMessage("Process",5,"BoxProcessMode     = "<<bbGetInputBoxProcessMode()<<std::endl);
    
    if ( ( bbGetStatus() == MODIFIED ) ||
	 ( bbBoxProcessModeIsAlways() ) )
      {
	bool wasExecuting = bbGlobalGetSomeBoxExecuting();
	bbGlobalSetSomeBoxExecuting(true);

	// Updates its inputs ** EXCLUDING "Parent" **
	IOStatus s = bbUpdateInputs(true);

	// ??? Status management on ForwardUpdate ???
	bbSetStatus(UPTODATE);

	// Creates the window 
	bbCreateWindow();

	// Children update (WxContainer)
	bbUpdateChildren(caller);	

	// User process
	bbProcess();

	bbGlobalSetSomeBoxExecuting(wasExecuting);
      }
    
    bbtkDebugMessage("Process",1,
		     "<= UserBlackBox::bbForwardUpdate() ["
		     <<bbGetFullName()<<"]"<<std::endl);

    bbtkDebugDecTab("Process",1);
  }
  //=========================================================================
  */
  
  
   
  //=========================================================================
  Data UserBlackBox::bbGetOutput( const std::string &name )
  {
    bbtkDebugMessageInc("Data",7,
			"UserBlackBox::bbGetOutput(\""<<name<<"\") ["
			<<bbGetFullName()<<"]"
			<<std::endl);
    
    Data p = ((UserBlackBoxOutputDescriptor*)bbGetDescriptor()->GetOutputDescriptor(name))->GetGetFunctor()->Get(this);
    
    bbtkDebugDecTab("Data",7);
    return p;
  }
  //=========================================================================
  
  
  //=========================================================================
  ///  Gets the input Data of a given name
  Data UserBlackBox::bbGetInput( const std::string &name ) 
  {
    bbtkDebugMessageInc("Data",7,
			"UserBlackBox::bbGetInput(\""<<name<<"\") ["
			<<bbGetFullName()<<"]"
			<<std::endl);  
    
    Data p = ((UserBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetGetFunctor()->Get(this);
    
    bbtkDebugDecTab("Data",7);
    return p;
  }
  //=========================================================================
  
  
  //=========================================================================
  ///  Sets the data of the output called <name>
  void UserBlackBox::bbSetOutput( const std::string &name, Data data)
  {
    bbtkDebugMessageInc("Data",7,
			"UserBlackBox::bbSetOutput(\""<<name<<"\",data) ["
			<<bbGetFullName()<<"]"
			<<std::endl); 
    
    ((UserBlackBoxOutputDescriptor*)bbGetDescriptor()->GetOutputDescriptor(name))->GetSetFunctor()->Set(this,data);
    
    bbtkDebugDecTab("Data",7);
  }  
  //=========================================================================
  
  
  //=========================================================================
  ///  Sets the data of the input called <name>
  void UserBlackBox::bbSetInput( const std::string &name, Data data, 
				 bool setModified )
  {
    bbtkDebugMessageInc("Data",7,
			"UserBlackBox::bbSetInput(\""<<name<<"\",data) ["
			<<bbGetFullName()<<"]"
			<<std::endl);  
    ((UserBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->Set(this,data);
    
    if (setModified) 
      {
	bbSetModifiedStatus();
      }
    
    bbtkDebugDecTab("Data",7);
  }
  //=========================================================================
  
    //=========================================================================
  ///  Sets the data of the input called <name>
  void UserBlackBox::bbBruteForceSetInputPointer( const std::string &name, 
						  void* data, 
						  bool setModified )
  {
    bbtkDebugMessageInc("Data",7,
			"UserBlackBox::bbBruteForceSetInputPointer(\""
			<<name<<"\",data) ["
			<<bbGetFullName()<<"]"
			<<std::endl);  
    ((UserBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->BruteForceSetPointer(this,data);
    
    if (setModified) 
      {
	bbSetModifiedStatus();
      }
    
    bbtkDebugDecTab("Data",7);
  }
  //=========================================================================
  
}
// EO namespace bbtk