kernel/src/bbtkBlackBox.cxx

   1 /*=========================================================================
   2
   3 Program:   bbtk
   4 Module:    $RCSfile: bbtkBlackBox.cxx,v $
   5 Language:  C++
   6 Date:      $Date: 2008/05/07 12:59:23 $
   7 Version:   $Revision: 1.18 $
   8
   9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10 l'Image). All rights reserved. See doc/license.txt or
  11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
  12
  13 This software is distributed WITHOUT ANY WARRANTY; without even
  14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15 PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19
  20 /**
  21  *  \file
  22  *  \brief Class bbtk::BlackBox : abstract black-box interface.
  23  */
  24 #include "bbtkBlackBox.h"
  25 #include "bbtkPackage.h"
  26 #include "bbtkMessageManager.h"
  27 #include "bbtkFactory.h"
  28
  29 #include "bbtkConfigurationFile.h"
  30 #include "bbtkWxBlackBox.h"
  31
  32 #include <fstream>
  33 //#include <vector>
  34
  35
  36 namespace bbtk
  37 {
  38
  39
  40   static bool bbmgSomeBoxExecuting = false;
  41   static bool bbmgFreezeExecution = false;
  42   static std::set<BlackBox::Pointer> bbmgExecutionList;
  43
  44   //=========================================================================
  45   BlackBox::Deleter::Deleter()
  46   {
  47   }
  48   //=========================================================================
  49
  50   //=========================================================================
  51   void BlackBox::Deleter::Delete(Object* p)
  52   {
  53     BlackBox* b = dynamic_cast<BlackBox*>(p);
  54     if (!b)
  55       {
  56         bbtkInternalError("BlackBox::Deleter::Delete("<<p->GetObjectName()
  57                           <<"["<<p<<"]) : "
  58                           <<"dynamic cast to BlackBox* failed !");
  59       }
  60     std::string name = p->GetObjectName();//b->bbGetNameWithParent();
  61     bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\")"<<std::endl);
  62
  63
  64     BlackBoxDescriptor::WeakPointer desc = b->bbGetDescriptor();
  65     bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : deleting black box"<<std::endl);
  66
  67     b->bbDelete();
  68
  69     bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : releasing descriptor ["<<desc.lock()<<"]"<<std::endl);
  70
  71     if (!desc.expired())
  72       {
  73         Package::WeakPointer pack = desc.lock()->GetPackage();
  74         if (!pack.expired())
  75           {
  76             Package::ReleaseBlackBoxDescriptor(pack,desc);
  77           }
  78         else
  79           {
  80             bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : descriptor package expired (was not held by a package and the box was the last instance)"<<std::endl);
  81           }
  82       }
  83     else
  84       {
  85         bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : descriptor expired : nothing to do (was not held by a package or the box is a complex black box prototype)"<<std::endl);
  86       }
  87     bbtkDebugMessage("object",2,"<## BlackBox::Deleter(\""<<name<<"\")"<<std::endl);
  88   }
  89   //=========================================================================
  90
  91   //=========================================================================
  92   BlackBox::BlackBox(const std::string &name)
  93     : bbmName(name),
  94       bbmStatus(MODIFIED),
  95       bbmBoxProcessMode("Pipeline"),
  96       bbmParent()
  97
  98   {
  99     bbtkDebugMessage("object",4,"==> BlackBox::BlackBox(\""
 100                      <<name<<"\")"<<std::endl);
 101     bbtkDebugMessage("object",4,"<== BlackBox::BlackBox(\""
 102                      <<name<<"\")"<<std::endl);
 103   }
 104   //=========================================================================
 105
 106   //=========================================================================
 107   BlackBox::BlackBox(const BlackBox&)
 108   {}
 109
 110   //=========================================================================
 111   BlackBox::BlackBox(BlackBox& from, const std::string &name)
 112     : bbmName(name),
 113       bbmStatus(from.bbmStatus),
 114       bbmBoxProcessMode(from.bbmBoxProcessMode),
 115       bbmParent()
 116
 117   {
 118     bbtkDebugMessage("object",4,"==> BlackBox::BlackBox("
 119                      <<from.bbGetFullName()<<",\""
 120                      <<name<<"\")"<<std::endl);
 121     bbtkDebugMessage("object",4,"<== BlackBox::BlackBox("
 122                      <<from.bbGetFullName()<<",\""
 123                      <<name<<"\")"<<std::endl);
 124   }
 125   //=========================================================================
 126
 127
 128   //=========================================================================
 129   BlackBox::~BlackBox()
 130   {
 131     bbtkDebugMessage("object",4,"==> BlackBox::~BlackBox() ["<<bbmName
 132                      <<"]"<<std::endl);
 133     this->bbDesallocateConnectors();
 134     bbtkDebugMessage("object",4,"<== BlackBox::~BlackBox() ["<<bbmName
 135                      <<"]"<<std::endl);
 136   }
 137   //=========================================================================
 138
 139
 140   //=========================================================================
 141   /// Main processing method of the box.
 142   void BlackBox::bbExecute(bool force)
 143   {
 144     bbtkDebugMessageInc("process",2,
 145                         "=> BlackBox::bbExecute() ["
 146                         <<bbGetFullName()<<"]"<<std::endl);
 147
 148     Wx::BeginBusyCursor();
 149
 150     // If execution frozen : return
 151     if (bbGlobalGetFreezeExecution())
 152       {
 153         bbtkDebugMessage("process",2,
 154                          " -> FreezeExecution global flag is 'true' : abort execution"<<std::endl);
 155       }
 156
 157     // If force is true then update is triggered even if the box is UPTODATE
 158     if (force) bbSetModifiedStatus();
 159
 160     // Calls the main recursive update method
 161     bbBackwardUpdate(Connection::Pointer());
 162
 163     Wx::EndBusyCursor();
 164
 165     bbtkDebugMessageDec("process",2,
 166                         "<= BlackBox::bbExecute() ["
 167                         <<bbGetFullName()<<"]"<<std::endl);
 168   }
 169   //=========================================================================
 170
 171   //=========================================================================
 172   std::string BlackBox::bbGetFullName() const
 173   {
 174     return this->bbGetNameWithParent()+"<"+this->bbGetDescriptor()->GetTypeName()+">";
 175   }
 176   //=========================================================================
 177
 178
 179
 180   //=========================================================================
 181   /// Returns the name with the name of the parent prepended if any
 182   std::string BlackBox::bbGetNameWithParent() const
 183   {
 184     if (bbmParent.lock())
 185       {
 186         return bbmParent.lock()->bbGetNameWithParent() + ":" + bbmName;
 187       }
 188     else
 189       {
 190         return bbmName;
 191       }
 192   }
 193   //=========================================================================
 194
 195   //=========================================================================
 196   /// Prints the Help on the BlackBox type
 197   void BlackBox::bbGetHelp(bool full) const
 198   {
 199     bbGetDescriptor()->GetHelp(full);
 200   }
 201   //=========================================================================
 202
 203
 204   //=========================================================================
 205   /// Returns true if the UserBlackBox has an input of name name
 206   bool BlackBox::bbHasInput(const std::string& name) const
 207   {
 208     bbtkDebugMessageInc("Kernel",8,
 209                         "BlackBox::bbHasInput(\""
 210                         <<name<<"\") ["<<bbGetFullName()<<"]"
 211                         <<std::endl);
 212     bool r = ( bbGetDescriptor()->GetInputDescriptorMap().find(name)
 213                != bbGetDescriptor()->GetInputDescriptorMap().end());
 214     bbtkDebugDecTab("Kernel",8);
 215     return r;
 216   }
 217   //=========================================================================
 218
 219
 220   //=========================================================================
 221   /// Returns true if the UserBlackBox has an output of name name
 222   bool BlackBox::bbHasOutput(const std::string& name) const
 223   {
 224     bbtkDebugMessageInc("Kernel",8,"BlackBox::bbHasOutput(\""
 225                         <<name<<"\") ["<<bbGetFullName()<<"]"<<std::endl);
 226     bool r = ( bbGetDescriptor()->GetOutputDescriptorMap().find(name)
 227                != bbGetDescriptor()->GetOutputDescriptorMap().end());
 228     bbtkDebugDecTab("Kernel",8);
 229     return r;
 230   }
 231   //=========================================================================
 232
 233
 234   //=========================================================================
 235   ///  Gets the output type of a given name
 236   TypeInfo BlackBox::bbGetOutputType( const std::string &name ) const
 237   {
 238     bbtkDebugMessageInc("Kernel",8,
 239                         "BlackBox::bbGetOutputType(\""
 240                         <<name<<"\") ["<<bbGetFullName()<<"]"<<std::endl);
 241     TypeInfo r = bbGetDescriptor()->GetOutputDescriptor(name)->GetTypeInfo();
 242     bbtkDebugDecTab("Kernel",8);
 243     return r;
 244   }
 245   //=========================================================================
 246
 247   //=========================================================================
 248   ///  Gets the input type of a given name
 249   TypeInfo BlackBox::bbGetInputType( const std::string &name ) const
 250   {
 251     bbtkDebugMessageInc("Kernel",8,
 252                         "BlackBox::bbGetInputType(\""
 253                         <<name<<"\") ["<<bbGetFullName()<<"]"<<std::endl);
 254     TypeInfo r = bbGetDescriptor()->GetInputDescriptor(name)->GetTypeInfo();
 255     bbtkDebugDecTab("Kernel",8);
 256     return r;
 257   }
 258   //=========================================================================
 259
 260
 261   //=========================================================================
 262   /// Allocates the i/o connectors of the black box
 263   void BlackBox::bbAllocateConnectors()
 264   {
 265     bbtkDebugMessageInc("Kernel",8,
 266                         "BlackBox::bbAllocateConnectors() ["
 267                         <<bbGetFullName()<<"]"
 268                         <<std::endl);
 269     const BlackBoxDescriptor::InputDescriptorMapType& imap
 270       = bbGetDescriptor()->GetInputDescriptorMap();
 271     BlackBoxDescriptor::InputDescriptorMapType::const_iterator i;
 272     for ( i = imap.begin(); i != imap.end(); ++i )
 273       {
 274         bbtkDebugMessage("Kernel",8,"* Allocate \""<<i->first<<"\""<<std::endl);
 275         bbGetInputConnectorMap()[i->second->GetName()]
 276           = new BlackBoxInputConnector(GetThisPointer<BlackBox>());
 277       }
 278     const BlackBoxDescriptor::OutputDescriptorMapType& omap
 279       = bbGetDescriptor()->GetOutputDescriptorMap();
 280     BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
 281     for ( o = omap.begin(); o != omap.end(); ++o )
 282       {
 283         bbtkDebugMessage("Kernel",8,"* Allocate \""<<o->first<<"\""<<std::endl);
 284         bbGetOutputConnectorMap()[o->second->GetName()]
 285           = new BlackBoxOutputConnector();
 286       }
 287     bbtkDebugDecTab("Kernel",8);
 288   }
 289   //=========================================================================
 290
 291
 292   //=========================================================================
 293   /// Desallocates the i/o connectors of the black box
 294   void BlackBox::bbDesallocateConnectors()
 295   {
 296     bbtkDebugMessageInc("Kernel",8,
 297                         "BlackBox::bbDesallocateConnectors()"
 298                         <<std::endl);
 299
 300     InputConnectorMapType::const_iterator i;
 301     for ( i = bbGetInputConnectorMap().begin();
 302           i != bbGetInputConnectorMap().end(); ++i )
 303       {
 304         bbtkDebugMessage("Kernel",8,"* Delete \""<<i->first<<"\""<<std::endl);
 305         delete (i->second);
 306       }
 307     OutputConnectorMapType::const_iterator o;
 308     for ( o = bbGetOutputConnectorMap().begin();
 309           o != bbGetOutputConnectorMap().end(); ++o )
 310       {
 311         bbtkDebugMessage("Kernel",8,"* Delete \""<<o->first<<"\""<<std::endl);
 312         delete (o->second);
 313       }
 314
 315     bbtkDebugDecTab("Kernel",8);
 316
 317   }
 318   //=========================================================================
 319
 320
 321   //=========================================================================
 322   /// Copies the input / output values from another box
 323   void BlackBox::bbCopyIOValues(BlackBox& from)
 324   {
 325     bbtkDebugMessageInc("Kernel",9,
 326                         "BlackBox::bbCopyIOValues("
 327                         <<from.bbGetFullName()<<") ["
 328                         <<bbGetFullName()<<"]"<<std::endl);
 329     // copies the input values
 330     const BlackBoxDescriptor::InputDescriptorMapType& imap
 331       = bbGetDescriptor()->GetInputDescriptorMap();
 332     BlackBoxDescriptor::InputDescriptorMapType::const_iterator i;
 333     for ( i = imap.begin(); i != imap.end(); ++i )
 334       {
 335         if (! i->second->GetCopyConstruct() ) continue;
 336         std::string input = i->second->GetName();
 337         this->bbSetInput(input, from.bbGetInput(input) );
 338       }
 339     // copies the output values
 340     const BlackBoxDescriptor::OutputDescriptorMapType& omap
 341       = bbGetDescriptor()->GetOutputDescriptorMap();
 342     BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
 343     for ( o = omap.begin(); o != omap.end(); ++o )
 344       {
 345         if (! o->second->GetCopyConstruct() ) continue;
 346         std::string output = o->second->GetName();
 347         this->bbSetOutput(output, from.bbGetOutput(output) );
 348       }
 349
 350     bbtkDebugDecTab("Kernel",9);
 351
 352   }
 353   //=========================================================================
 354
 355
 356
 357   //=========================================================================
 358   bool BlackBox::bbCanReact() const
 359   {
 360     return ( bbGlobalGetSomeBoxExecuting()
 361 #ifdef _USE_WXWIDGETS_
 362              || Wx::IsSomeWindowAlive()
 363 #endif
 364              );
 365   }
 366   //=========================================================================
 367
 368
 369
 370   //=========================================================================
 371   /// User overloadable destruction method of a black box
 372   void BlackBox::bbUserDelete()
 373   {
 374     bbtkDebugMessage("process",5,
 375                      "=> BlackBox::bbUserDelete() ["
 376                      <<bbGetFullName()<<"]"
 377                      <<" : not overloaded; using standard deletion"
 378                      <<std::endl);
 379     delete this;
 380   }
 381   //=========================================================================
 382
 383
 384   //=========================================================================
 385   BlackBox::BoxProcessModeValue BlackBox::bbGetBoxProcessModeValue() const
 386   {
 387     const std::string& p = bbmBoxProcessMode;
 388     if ( (p == "0") ||
 389          (p == "P") || (p == "p") ||
 390          (p == "Pipeline") || (p == "pipeline") ) return Pipeline;
 391     if ( (p == "1") ||
 392          (p == "A") || (p == "a") ||
 393          (p == "Always") || (p == "always") ) return Always;
 394     if ( (p == "2") ||
 395          (p == "R") || (p == "r") ||
 396          (p == "Reactive") || (p == "reactive") ) return Reactive;
 397     bbtkError(bbGetFullName()<<" : BoxProcessMode value '"<<p
 398               <<"' unknown. Possible values : "
 399               <<"'0'/'P'/'p'/'Pipeline'/'pipeline' | "
 400               <<"'1'/'A'/'a'/'Always'/'always' | "
 401               <<"'2'/'R'/'r'/'Reactive'/'reactive'"<<std::endl);
 402   }
 403   //=========================================================================
 404
 405   //=========================================================================
 406   bool  BlackBox::bbBoxProcessModeIsReactive() const
 407   {
 408     return (bbGetBoxProcessModeValue() == Reactive);
 409   }
 410   //=========================================================================
 411
 412   //=========================================================================
 413   bool  BlackBox::bbBoxProcessModeIsAlways() const
 414   {
 415     return (bbGetBoxProcessModeValue() == Always);
 416   }
 417   //=========================================================================
 418
 419   //=========================================================================
 420   ///  Signals that the BlackBox has been modified
 421   void BlackBox::bbSetModifiedStatus(BlackBoxInputConnector* c)
 422   {
 423     bbtkDebugMessage("modified",1,
 424                      "==> BlackBox::bbSetModifiedStatus("<<c<<") ["
 425                      <<bbGetFullName()<<"]"<<std::endl);
 426
 427     if ( (c==bbGetInputConnectorMap().find("WinHide")->second) )
 428       //         && (bbCanReact()))
 429       {
 430         bbtkDebugMessage("modified",2,
 431                          "-> Hide triggered by WinHide input change"
 432                          <<std::endl);
 433         this->bbHideWindow();
 434         this->bbSetStatus(MODIFIED);
 435         return;
 436       }
 437
 438     if ( ( bbBoxProcessModeIsReactive()  ||
 439            (c==bbGetInputConnectorMap().find("BoxExecute")->second))
 440          && (bbCanReact() ) )
 441       {
 442         bbtkDebugMessage("modified",2,
 443                          "-> Execution triggered by Reactive mode or BoxExecute input change"<<std::endl);
 444         this->bbSetStatus(MODIFIED);
 445         bbGlobalAddToExecutionList( GetThisPointer<BlackBox>() );
 446       }
 447     else if ( bbGetStatus() == MODIFIED ) //! this->bbIsUptodate())
 448       {
 449         bbtkDebugMessage("modified",2,"-> Already modified"<<std::endl);
 450         return;
 451       }
 452     else
 453       {
 454         bbtkDebugMessage("modified",2,"-> Status set to modified"<<std::endl);
 455         this->bbSetStatus(MODIFIED);
 456       }
 457
 458     this->bbSignalOutputModification(false);
 459
 460     /*
 461   bbtkDebugMessageDec("process",5,
 462                         "<= BlackBox::bbSetModifiedStatus("<<c<<") ["
 463                         <<bbGetFullName()<<"]"<<std::endl);
 464     */
 465   }
 466   //=========================================================================
 467
 468   //=========================================================================
 469   void BlackBox::bbSignalOutputModification(bool reaction)
 470   {
 471     bbtkDebugMessageInc("process",5,
 472                         "=> BlackBox::bbSignalOutputModification() ["
 473                         <<bbGetFullName()<<"]"<<std::endl);
 474
 475     OutputConnectorMapType::iterator change = bbGetOutputConnectorMap().end();
 476     OutputConnectorMapType::iterator i;
 477     for ( i  = bbGetOutputConnectorMap().begin();
 478           i != bbGetOutputConnectorMap().end(); ++i) {
 479       /*     if ( i->first == "BoxChange" )
 480         {
 481           change = i;
 482           continue;
 483         }
 484       */
 485       i->second->SetModifiedStatus();
 486     }
 487     //    if (change != bbGetOutputConnectorMap().end())
 488     // change->second->SetModifiedStatus();
 489
 490     if (reaction) bbGlobalProcessExecutionList();
 491
 492     bbtkDebugMessageDec("process",5,
 493                         "<= BlackBox::bbSignalOutputModification() ["
 494                         <<bbGetFullName()<<"]"<<std::endl);
 495
 496   }
 497   //=========================================================================
 498   //=========================================================================
 499   void BlackBox::bbSignalOutputModification(const std::string& output,
 500         bool reaction)
 501   {
 502     bbtkDebugMessageInc("process",5,
 503                         "=> BlackBox::bbSignalOutputModification("
 504                         <<output<<") ["
 505                         <<bbGetFullName()<<"]"<<std::endl);
 506
 507     OutputConnectorMapType::iterator i = bbGetOutputConnectorMap().find(output);
 508     if ( i == bbGetOutputConnectorMap().end() )
 509         {
 510           bbtkError("BlackBox["<<bbGetFullName()<<"]::bbSignalOutputModification("<<output<<") : unknown output");
 511         }
 512     i->second->SetModifiedStatus();
 513     // Has to notify the output "BoxChange" also
 514     if (output != "BoxChange")
 515       {
 516         i = bbGetOutputConnectorMap().find("BoxChange");
 517         if ( i != bbGetOutputConnectorMap().end() )
 518           {
 519             i->second->SetModifiedStatus();
 520           }
 521       }
 522   if (reaction) bbGlobalProcessExecutionList();
 523
 524   bbtkDebugMessageDec("process",5,
 525                       "<= BlackBox::bbSignalOutputModification("
 526                       <<output<<") ["
 527                       <<bbGetFullName()<<"]"<<std::endl);
 528
 529   }
 530   //=========================================================================
 531   //=========================================================================
 532   void BlackBox::bbSignalOutputModification(const std::vector<std::string>& output,
 533         bool reaction)
 534   {
 535     bbtkDebugMessageInc("process",5,
 536                         "=> BlackBox::bbSignalOutputModification(vector of outputs) ["
 537                         <<bbGetFullName()<<"]"<<std::endl);
 538     OutputConnectorMapType::iterator i;
 539     std::vector<std::string>::const_iterator o;
 540     for (o=output.begin();o!=output.end();++o)
 541       {
 542         // the output "BoxChange" must be signaled **AFTER** all others
 543         if (*o == "BoxChange") continue;
 544         // Look for the connector
 545         i = bbGetOutputConnectorMap().find(*o);
 546         if ( i == bbGetOutputConnectorMap().end() )
 547           {
 548             bbtkError("BlackBox["<<bbGetFullName()<<"]::bbSignalOutputModification("<<*o<<") : unknown output");
 549           }
 550         i->second->SetModifiedStatus();
 551       }
 552     // Has to notify the output "BoxChange" also
 553     i = bbGetOutputConnectorMap().find("BoxChange");
 554     if ( i != bbGetOutputConnectorMap().end() )
 555       {
 556         i->second->SetModifiedStatus();
 557       }
 558   if (reaction) bbGlobalProcessExecutionList();
 559
 560    bbtkDebugMessageDec("process",5,
 561                        "<= BlackBox::bbSignalOutputModification(vector of outputs) ["
 562                         <<bbGetFullName()<<"]"<<std::endl);
 563
 564   }
 565   //=========================================================================
 566
 567   //=========================================================================
 568   /// Updates the BlackBox inputs
 569   /// \returns UPTODATE if all inputs are in UPTODATE status after update
 570   ///          else MODIFIED
 571   IOStatus BlackBox::bbUpdateInputs(bool excludeParent)
 572   {
 573     bbtkDebugMessageInc("process",4,
 574                         "=> BlackBox::bbUpdateInputs() ["
 575                         <<bbGetFullName()<<"]"
 576                         <<std::endl);
 577
 578     IOStatus s = UPTODATE;
 579
 580     InputConnectorMapType::iterator i;
 581     for ( i = bbGetInputConnectorMap().begin();
 582           i!= bbGetInputConnectorMap().end(); ++i)
 583       {
 584         if (excludeParent && (i->first=="WinParent")) continue;
 585         if (i->first=="WinHide") continue;
 586         // If input type is Void : no recurse
 587         //if (  bbGetDescriptor()->GetInputDescriptor(i->first)->GetTypeInfo()
 588         //      == typeid(Void) )
 589         //  continue;
 590
 591         IOStatus t = i->second->BackwardUpdate();
 592         if (t==MODIFIED) s = MODIFIED;
 593       }
 594
 595    bbtkDebugMessageDec("process",4,
 596                         "<= BlackBox::bbUpdateInputs() ["
 597                         <<bbGetFullName()<<"]"
 598                         <<std::endl);
 599
 600
 601     return s;
 602   }
 603   //=========================================================================
 604
 605
 606   //=========================================================================
 607   /// Connects the input <name> to the connection c
 608   void BlackBox::bbConnectInput( const std::string& name, Connection* c)
 609   {
 610     bbtkDebugMessage("connection",2,
 611                         "==> BlackBox::bbConnectInput(\""
 612                         <<name<<"\","<<c->GetFullName()<<") ["
 613                         <<bbGetFullName()<<"]"
 614                         <<std::endl);
 615
 616
 617     InputConnectorMapType::iterator i = bbGetInputConnectorMap().find(name);
 618     if (i==bbGetInputConnectorMap().end())
 619       {
 620         bbtkError("no input called '"<<name<<"'");
 621       }
 622     i->second->SetConnection(c);
 623
 624     bbtkDebugMessage("connection",2,
 625                         "<== BlackBox::bbConnectInput(\""
 626                         <<name<<"\","<<c->GetFullName()<<") ["
 627                         <<bbGetFullName()<<"]"
 628                         <<std::endl);
 629     //  bbSetModifiedStatus();
 630
 631   }
 632   //=========================================================================
 633
 634
 635   //=========================================================================
 636   /// Connects the output <name> to the connection c
 637   void BlackBox::bbConnectOutput( const std::string& name, Connection* c)
 638   {
 639     bbtkDebugMessage("connection",2,
 640                      "==> BlackBox::bbConnectOutput(\""<<name<<"\","
 641                      <<c->GetFullName()<<") ["
 642                      <<bbGetFullName()<<"]"<<std::endl);
 643
 644     OutputConnectorMapType::iterator i = bbGetOutputConnectorMap().find(name);
 645     if (i==bbGetOutputConnectorMap().end())
 646       {
 647         bbtkError("no output called '"<<name<<"'");
 648       }
 649     i->second->SetConnection(c);
 650
 651     bbtkDebugMessage("connection",2,
 652                      "<== BlackBox::bbConnectOutput(\""<<name<<"\","
 653                      <<c->GetFullName()<<") ["
 654                      <<bbGetFullName()<<"]"<<std::endl);
 655
 656   }
 657   //=========================================================================
 658
 659
 660   //=========================================================================
 661   /// Disconnects the input <name> from the connection c
 662   void BlackBox::bbDisconnectInput( const std::string& name, Connection* c)
 663   {
 664
 665     bbtkDebugMessage("connection",2,
 666                      "==> BlackBox::bbDisconnectInput(\""<<name
 667                      <<"\","<<c->GetFullName()<<") ["
 668                      <<bbGetFullName()<<"]"
 669                      <<std::endl);
 670
 671     if (!c)
 672       {
 673
 674         bbtkDebugMessage("connection",2,"c==0"<<std::endl);
 675         return;
 676       }
 677
 678     InputConnectorMapType::iterator i = bbGetInputConnectorMap().find(name);
 679     if (i==bbGetInputConnectorMap().end())
 680       {
 681         bbtkError("no input called '"<<name<<"'");
 682       }
 683     i->second->UnsetConnection(c);
 684
 685     bbtkDebugMessage("connection",2,
 686                      "<== BlackBox::bbDisconnectInput(\""<<name
 687                      <<"\","<<c->GetFullName()<<") ["
 688                      <<bbGetFullName()<<"]"
 689                      <<std::endl);
 690
 691   }
 692   //=========================================================================
 693
 694
 695   //=========================================================================
 696   /// Disconnects the output <name> from the connection c
 697   void BlackBox::bbDisconnectOutput( const std::string& name, Connection* c)
 698   {
 699     bbtkDebugMessage("connection",2,
 700                      "==> BlackBox::bbDisconnectOutput(\""<<name
 701                      <<"\","<<c->GetFullName()<<") ["
 702                      <<bbGetFullName()<<"]"
 703                      <<std::endl);
 704     if (!c)
 705       {
 706
 707         bbtkDebugMessage("connection",2,"c==0"<<std::endl);
 708         return;
 709       }
 710
 711     OutputConnectorMapType::iterator i = bbGetOutputConnectorMap().find(name);
 712     if (i==bbGetOutputConnectorMap().end())
 713       {
 714         bbtkError("no output called '"<<name<<"'");
 715       }
 716     i->second->UnsetConnection(c);
 717
 718     bbtkDebugMessage("connection",2,
 719                      "<== BlackBox::bbDisconnectOutput(\""<<name
 720                      <<"\","<<c->GetFullName()<<") ["
 721                      <<bbGetFullName()<<"]"
 722                      <<std::endl);
 723   }
 724   //=========================================================================
 725
 726
 727   //=========================================================================
 728   /// Virtual
 729   void BlackBox::bbWriteDotInputOutputName(FILE *ff,bool inputoutput,int detail, int level)
 730   {
 731     fprintf(ff,"%s%p",bbGetTypeName().c_str(),this);
 732   }
 733   //=========================================================================
 734
 735
 736   //=========================================================================
 737   std::string BlackBox::bbGetOutputAsString( const std::string &output )
 738   {
 739     std::string v;
 740     // Looks for the adaptor
 741     if (bbGetOutputType(output).name() != typeid(std::string).name() )
 742       {
 743         // Look for factory
 744         Package::Pointer p = bbGetDescriptor()->GetPackage();
 745         if ((p != 0) && ( ! p->GetFactorySet().empty() ) )
 746           {
 747             Factory::Pointer f = p->GetFactorySet().begin()->lock();
 748             BlackBox::Pointer a;
 749             try
 750               {
 751                 a = f->NewAdaptor(
 752                                   bbGetOutputType(output),
 753                                   typeid(std::string),
 754                                   "");
 755               } catch (bbtk::Exception e)
 756               {
 757               }
 758             if (a){
 759               //                        bbUpdate();
 760               a->bbSetInput("In",bbGetOutput(output));
 761               a->bbExecute();
 762               v = a->bbGetOutput("Out").unsafe_get<std::string>() ;
 763             } else {
 764               v="? (no adaptor found)";
 765             }
 766           }
 767         else
 768           {
 769             v="? (no factory found)";
 770           }
 771       }
 772     else
 773       {
 774         //         bbUpdate();
 775         v = bbGetOutput(output).unsafe_get<std::string>() ;
 776       }
 777     return v;
 778   }
 779   //=========================================================================
 780
 781   //=========================================================================
 782   std::string BlackBox::bbGetInputAsString( const std::string &input )
 783   {
 784     std::string v;
 785     // Looks for the adaptor
 786     if (bbGetInputType(input) != typeid(std::string))
 787       {
 788         // Look for factory
 789         Package::Pointer p = bbGetDescriptor()->GetPackage();
 790         if ((p != 0) && ( ! p->GetFactorySet().empty() ) )
 791           {
 792             Factory::Pointer f = p->GetFactorySet().begin()->lock();
 793             BlackBox::Pointer a;
 794             try
 795               {
 796                 a = f->NewAdaptor(
 797                                bbGetInputType(input),
 798                                typeid(std::string),
 799                                "");
 800               }catch (bbtk::Exception e)
 801               {
 802               }
 803             if (a)
 804               {
 805                 //                      bbUpdate();
 806                 a->bbSetInput("In",bbGetInput(input));
 807                 a->bbExecute();
 808                 v = a->bbGetOutput("Out").unsafe_get<std::string>() ;
 809               }
 810             else
 811               {
 812                 v="? (no adaptor found)";
 813               }
 814           }
 815         else
 816           {
 817             v="? (no factory found)";
 818           }
 819       }
 820     else
 821       {
 822         v = bbGetInput(input).unsafe_get<std::string>() ;
 823       }
 824     return v;
 825   }
 826   //=======================================================================
 827
 828   //=======================================================================
 829   // Replaces substrings "<" by "["
 830   void SubsBrackets ( std::string& s )
 831   {
 832     //   std::cout << "BEFORE=["<<s<<"]"<<std::endl;
 833     std::string ss("<");
 834     std::string::size_type pos = 0;
 835     pos = s.find(ss,0);
 836     char* cr = "[";
 837     while ( pos != std::string::npos )
 838       {
 839         //      std::cout << "*** find one "<<std::endl;
 840         s.replace(pos,1,cr,1);
 841         pos = s.find(ss, pos);
 842       }
 843     ss = ">";
 844     pos = 0;
 845     pos = s.find(ss,0);
 846     cr = "]";
 847     while ( pos != std::string::npos )
 848       {
 849         //      std::cout << "*** find one "<<std::endl;
 850         s.replace(pos,1,cr,1);
 851         pos = s.find(ss, pos);
 852       }
 853     ss = ",";
 854     pos = 0;
 855     pos = s.find(ss,0);
 856     cr = "-";
 857     while ( pos != std::string::npos )
 858       {
 859         //      std::cout << "*** find one "<<std::endl;
 860         s.replace(pos,1,cr,1);
 861         pos = s.find(ss, pos);
 862       }     //    std::cout << "AFTER=["<<s<<"]"<<std::endl;
 863   }
 864   //=======================================================================
 865
 866   //=========================================================================
 867   /// Write Graphviz-dot description in file
 868   void BlackBox::bbWriteDotFileBlackBox(FILE *ff,
 869                                         BlackBox::Pointer parentblackbox,
 870                                         int detail, int level,
 871                                         bool instanceOrtype,
 872                                         bool relative_link )
 873
 874   {
 875     InputConnectorMapType::iterator i;
 876     // label
 877     std::string labelStr;
 878     std::string valueStr("");
 879
 880         if (detail==0) {
 881                 labelStr = bbGetName() ;
 882 //EED 18 Fev 2008
 883                 labelStr = labelStr + "\\n[" +this->bbGetDescriptor()->GetPackage()->GetName()+"::"+ bbGetTypeName() + "]";
 884         } else {
 885                 labelStr = bbGetName();
 886                 labelStr = labelStr + "   [" +this->bbGetDescriptor()->GetPackage()->GetName()+"::"+ bbGetTypeName() + "]  ";
 887     }
 888
 889     SubsBrackets(labelStr);
 890     if (detail==1)
 891       {
 892         labelStr = labelStr + " | {{ ";
 893         std::string tempStrTypeName;
 894         bool tmp;
 895         tmp=false;
 896         for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
 897           {
 898             if (tmp==true)
 899               {
 900                 labelStr=labelStr+" | ";
 901               }
 902             tmp=true;
 903             if (instanceOrtype==true)
 904               {
 905                 valueStr = this->bbGetInputAsString(i->first) + " = ";
 906               }
 907             const BlackBoxInputDescriptor* id = bbGetDescriptor()->GetInputDescriptor(i->first);
 908             tempStrTypeName=id->GetTypeName();
 909             SubsBrackets(tempStrTypeName);
 910             std::string Name(i->first);
 911             SubsBrackets(Name);
 912             labelStr=labelStr + "<"+i->first.c_str()+"> "  + valueStr +  Name.c_str() + "  [" + tempStrTypeName.c_str() + "]";
 913           }
 914         labelStr=labelStr+ " } | {";
 915         tmp = false;
 916         OutputConnectorMapType::iterator ii;
 917         for ( ii = mOutputConnectorMap.begin(); ii != mOutputConnectorMap.end(); ++ii )
 918         {
 919            if (tmp==true)
 920            {
 921                    labelStr=labelStr+" | ";
 922            }
 923            tmp = true;
 924            if (instanceOrtype==true)
 925            {
 926                    valueStr = this->bbGetOutputAsString(ii->first) + " = ";
 927            }
 928            const BlackBoxOutputDescriptor* id = bbGetDescriptor()->GetOutputDescriptor(ii->first);
 929            tempStrTypeName=id->GetTypeName();
 930            SubsBrackets(tempStrTypeName);
 931             std::string Name(ii->first);
 932             SubsBrackets(Name);
 933            labelStr=labelStr+"<"+ii->first.c_str()+"> " + valueStr + Name.c_str() + "  ["+tempStrTypeName+"]";
 934         }
 935         labelStr = labelStr+ "      } }" ;
 936 } // detail
 937
 938     fprintf(ff,"  " );
 939     bbWriteDotInputOutputName(ff,true,detail,level);
 940     std::string tmp ( bbGetTypeName() );
 941     SubsBrackets(tmp);
 942     std::string url;
 943     if (relative_link)
 944       url = this->bbGetDescriptor()->GetPackage()->GetDocRelativeURL() + "#" + tmp;
 945     else
 946       url = this->bbGetDescriptor()->GetPackage()->GetDocURL() + "#" + tmp;
 947
 948     fprintf( ff , " [shape=record, URL=\"%s\",label=\"%s\"]%s\n",url.c_str(),labelStr.c_str(),";" );
 949     //    std::cout  << labelStr << std::endl;
 950
 951     // Relation Input
 952     if (GetThisPointer<BlackBox>()!=parentblackbox){
 953       for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
 954         {
 955           if (i->second)
 956             {
 957               Connection* con = i->second->GetConnection();
 958               if (con!=NULL){
 959                 BlackBox::Pointer a=con->GetOriginalBlackBoxFrom();
 960                 BlackBox::Pointer b=con->GetOriginalBlackBoxTo();
 961                 fprintf(ff,"  ");
 962                 a->bbWriteDotInputOutputName(ff,false,detail,level);
 963                 if (detail==1)
 964                   {
 965                     fprintf(ff,":%s",con->GetOriginalBlackBoxFromOutput().c_str());
 966                   }
 967                 fprintf(ff,"->");
 968                 b->bbWriteDotInputOutputName(ff,true,detail,level);
 969                 if (detail==1)
 970                   {
 971                     fprintf(ff,":%s",con->GetOriginalBlackBoxToInput().c_str());
 972                   }
 973                 fprintf(ff,"%s\n",";");
 974               }  // if con
 975             } // if second
 976         } // for
 977     } // if parentblackbox
 978   }
 979   //=========================================================================
 980
 981
 982
 983
 984   //=========================================================================
 985   void BlackBox::bbShowRelations(BlackBox::Pointer parentblackbox,
 986                                  int detail, int level
 987                                  /*,Factory *factory*/ )
 988   {
 989
 990     if (this->bbGetDescriptor()->GetPackage())
 991       {
 992         bbtkMessage("Help",1,"Black Box '"<<bbGetName()<<"' <"<<
 993                     this->bbGetDescriptor()->GetPackage()->GetName()
 994                     <<"::"<<this->bbGetDescriptor()->GetTypeName()<<">"<<std::endl);
 995       }
 996     else
 997       {
 998         bbtkMessage("Help",1,"Black Box <::"<<this->bbGetDescriptor()->GetTypeName()<<">"<<std::endl);
 999       }
1000     //    bbtkMessage("Help",1," "<<GetDescription()<<std::endl);
1001     //    bbtkMessage("Help",1," By : "<<GetAuthor()<<std::endl);
1002
1003     std::vector<std::string> iname;
1004     std::vector<std::string> ivalue;
1005     std::vector<std::string> iconn;
1006
1007     InputConnectorMapType::iterator i;
1008     unsigned int namelmax = 0;
1009     unsigned int valuelmax = 0;
1010     unsigned int connlmax = 0;
1011     for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
1012       {
1013         iname.push_back(i->first);
1014         if (iname.back().size()>namelmax) namelmax = iname.back().size();
1015         ivalue.push_back(bbGetInputAsString(i->first));
1016         if (ivalue.back().size()>valuelmax) valuelmax = ivalue.back().size();
1017         std::string s("");
1018         Connection* con = i->second->GetConnection();
1019         if (con!=0){
1020           s = con->GetOriginalBlackBoxFrom()->bbGetName();
1021           s += ".";
1022           s += con->GetOriginalBlackBoxFromOutput();
1023         }  // if con
1024         iconn.push_back(s);
1025       }
1026     OutputConnectorMapType::iterator o;
1027     std::vector<std::string> oname;
1028     std::vector<std::string> ovalue;
1029     std::vector<std::vector<std::string> > oconn;
1030     for ( o = mOutputConnectorMap.begin(); o != mOutputConnectorMap.end(); ++o )
1031       {
1032         oname.push_back(o->first);
1033         if (oname.back().size()>namelmax) namelmax = oname.back().size();
1034         ovalue.push_back(bbGetOutputAsString(o->first));
1035         if (ovalue.back().size()>valuelmax) valuelmax = ovalue.back().size();
1036         std::vector<std::string> ss;
1037         const std::vector<Connection*>& con
1038           = o->second->GetConnectionVector();
1039         std::vector<Connection*>::const_iterator c;
1040         for (c=con.begin();c!=con.end();++c)
1041           {
1042             std::string s;
1043             s = (*c)->GetOriginalBlackBoxTo()->bbGetName();
1044             s += ".";
1045             s += (*c)->GetOriginalBlackBoxToInput();
1046             ss.push_back(s);
1047         }  // if con
1048         oconn.push_back(ss);
1049       }
1050
1051     if (iname.size())
1052       bbtkMessage("Help",1," * Inputs : "<<std::endl);
1053     else
1054       bbtkMessage("Help",1," * No inputs"<<std::endl);
1055
1056     std::vector<std::string>::iterator i1,i2,i3;
1057     for (i1=iname.begin(),i2=ivalue.begin(),i3=iconn.begin();
1058          i1!=iname.end(),i2!=ivalue.end(),i3!=iconn.end();
1059          ++i1,++i2,++i3)
1060       {
1061         std::string name(*i1);
1062         name += "'";
1063         name.append(1+namelmax-name.size(),' ');
1064         std::string value(*i2);
1065         value += "'";
1066         value.append(1+valuelmax-value.size(),' ');
1067         if (i3->size())
1068           bbtkMessage("Help",1,"    '"<<name<<" = '"<<value<<" <-- '"<<*i3<<"'"<<std::endl);
1069         else
1070           bbtkMessage("Help",1,"    '"<<name<<" = '"<<value<<std::endl);
1071       }
1072
1073     if (oname.size())
1074       bbtkMessage("Help",1," * Outputs : "<<std::endl);
1075     else
1076       bbtkMessage("Help",1," * No outputs"<<std::endl);
1077
1078     std::vector<std::vector<std::string> >::iterator i4;
1079
1080     for (i1=oname.begin(),i2=ovalue.begin(),i4=oconn.begin();
1081          i1!=oname.end(),i2!=ovalue.end(),i4!=oconn.end();
1082          ++i1,++i2,++i4)
1083       {
1084         std::string name(*i1);
1085         name += "'";
1086         name.append(1+namelmax-name.size(),' ');
1087         std::string value(*i2);
1088         value += "'";
1089         value.append(1+valuelmax-value.size(),' ');
1090         if (!(*i4).size())
1091           bbtkMessage("Help",1,"    '"<<name<<" = '"<<value<<std::endl);
1092         else
1093           {
1094             std::string pref = "    '"+name+" = '"+value;
1095             for (i3=i4->begin();i3!=i4->end();++i3)
1096               {
1097                 bbtkMessage("Help",1,pref<<" --> '"<<*i3<<"'"<<std::endl);
1098                 pref.replace(0,pref.size(),pref.size(),' ');
1099               }
1100           }
1101       }
1102
1103    }
1104   //=========================================================================
1105
1106
1107   //=========================================================================
1108    void BlackBox::bbGlobalProcessExecutionList()
1109    {
1110      bbtkDebugMessageInc("process",3,
1111                          "=> BlackBox::bbGlobalProcessExecutionList()"
1112                          <<std::endl);
1113
1114      std::set<BlackBox::Pointer>::iterator i;
1115      for (i=bbmgExecutionList.begin();
1116           i!=bbmgExecutionList.end();
1117           ++i)
1118        {
1119          bbtkDebugMessage("process",4,
1120                           " -> Executing "<<(*i)->bbGetFullName()<<std::endl);
1121          (*i)->bbExecute(true);
1122        }
1123
1124      bbmgExecutionList.clear();
1125      bbtkDebugMessageDec("process",3,
1126                          "<= BlackBox::bbGlobalProcessExecutionList()"
1127                          <<std::endl);
1128
1129
1130    }
1131   //=========================================================================
1132
1133     bool BlackBox::bbGlobalGetSomeBoxExecuting()
1134         {
1135                 return bbmgSomeBoxExecuting;
1136         }
1137
1138     void BlackBox::bbGlobalSetSomeBoxExecuting(bool b)
1139         {
1140                 bbmgSomeBoxExecuting = b;
1141         }
1142
1143     void BlackBox::bbGlobalSetFreezeExecution(bool b)
1144         {
1145                 bbmgFreezeExecution = b;
1146         }
1147
1148     bool BlackBox::bbGlobalGetFreezeExecution()
1149         {
1150                 return bbmgFreezeExecution;
1151         }
1152
1153   void BlackBox::bbGlobalAddToExecutionList( BlackBox::Pointer b )
1154         {
1155                 bbmgExecutionList.insert(b);
1156         }
1157
1158
1159   //=========================================================================
1160   // Static members initialization
1161 /*EED
1162   bool BlackBox::bbmgSomeBoxExecuting = false;
1163   bool BlackBox::bbmgFreezeExecution = false;
1164   std::set<BlackBox*> BlackBox::bbmgExecutionList;
1165 */
1166    //=========================================================================
1167
1168   //=========================================================================
1169   void BlackBox::Check(bool recursive)
1170   {
1171     bbtkMessage("debug",1,"*** Checking Black Box "<<(void*)this<<" ["<<bbGetFullName()
1172                 <<"] ... OK"<<std::endl);
1173   }
1174   //=========================================================================
1175
1176
1177
1178 }  // EO namespace bbtk
1179
1180 // EOF
1181