1 /*=========================================================================
4 Module: $RCSfile: bbtkComplexBlackBox.cxx,v $
6 Date: $Date: 2008/04/18 12:59:15 $
7 Version: $Revision: 1.10 $
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.
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.
17 =========================================================================*/
22 * \brief class bbtk::ComplexBlackBox : user defined complex black boxes
24 #include "bbtkComplexBlackBox.h"
25 #include "bbtkBlackBoxDescriptor.h"
26 #include "bbtkFactory.h"
27 #include "bbtkConfigurationFile.h"
32 //==========================================================================
33 /// Creates a new complex black box
34 ComplexBlackBox::Pointer ComplexBlackBox::New(const std::string& name,
35 ComplexBlackBoxDescriptor::Pointer desc)
37 bbtkDebugMessage("object",1,"##> ComplexBlackBox::New('"<<name<<"','"<<
38 desc->GetTypeName()<<"')" <<bbtkendl);
39 ComplexBlackBox::Pointer p =
40 MakeBlackBoxPointer(new ComplexBlackBox(name,desc));
41 bbtkDebugMessage("object",2,"<## ComplexBlackBox::New('"<<name<<"','"<<
42 desc->GetTypeName()<<"')" <<bbtkendl);
45 //==========================================================================
47 //=======================================================================
48 /// Usefull constructor
49 ComplexBlackBox::ComplexBlackBox(const std::string &name,
50 ComplexBlackBoxDescriptor::Pointer desc)
53 mLockedDescriptor(desc),
56 bbtkDebugMessage("object",3,
57 "##> ComplexBlackBox::ComplexBlackBox(\""
58 <<name<<"\")"<<std::endl);
59 bbAllocateConnectors();
60 bbtkDebugMessage("object",3,
61 "<## ComplexBlackBox::ComplexBlackBox(\""
62 <<name<<"\")"<<std::endl);
64 //=======================================================================
66 //=======================================================================
67 /// Constructor from an existing box (copy) with a new name
68 ComplexBlackBox::ComplexBlackBox(ComplexBlackBox& from,
69 const std::string &name)
70 : BlackBox(from,name),
71 // The locked descriptor is copied from the unlocked one
72 // to make the box a non-prototype !!
73 mLockedDescriptor(from.mDescriptor),
74 mDescriptor(from.mDescriptor),
75 mExecutionList(from.mExecutionList)
77 bbtkDebugMessage("object",3,
78 "##> ComplexBlackBox::ComplexBlackBox(\""
79 <<from.bbGetName()<<"\",\""
80 <<name<<"\")"<<std::endl);
81 bbtkDebugMessage("object",4," * Cloning Black Boxes"<<std::endl);
82 BlackBoxMapType::const_iterator i;
83 for ( i = from.mBlackBoxMap.begin(); i != from.mBlackBoxMap.end(); ++i )
85 bbtkDebugMessageInc("object",5," * Cloning \""<<i->first<<"\""<<std::endl);
86 BlackBox::Pointer B = i->second->bbClone(i->second->bbGetName());
87 bbUnsafeAddBlackBox(B);
91 bbtkDebugMessage("object",4," * Cloning Connections"<<std::endl);
92 ConnectionListType::const_iterator j;
93 for ( j = from.mConnectionList.begin(); j != from.mConnectionList.end(); ++j )
95 bbtkDebugMessage("object",5," * Cloning \""<<
96 (*j)->GetFullName()<<"\""<<std::endl);
98 BlackBox::Pointer bbfrom = bbGetBlackBox( (*j)->GetOriginalBlackBoxFrom()->bbGetName() );
99 BlackBox::Pointer bbto = bbGetBlackBox( (*j)->GetOriginalBlackBoxTo()->bbGetName() );
101 Connection::Pointer c = mDescriptor.lock()->GetFactory()->
102 NewConnection( bbfrom,
103 (*j)->GetOriginalBlackBoxFromOutput(),
105 (*j)->GetOriginalBlackBoxToInput() );
112 bbAllocateConnectors();
113 bbtkDebugMessage("object",3,
114 "<## ComplexBlackBox::ComplexBlackBox(\""
115 <<from.bbGetName()<<"\",\""
116 <<name<<"\")"<<std::endl);
118 //=======================================================================
120 //=======================================================================
122 ComplexBlackBox::~ComplexBlackBox()
124 bbtkDebugMessage("object",3,
125 "==> ComplexBlackBox::~ComplexBlackBox() ["
126 <<bbGetName()<<"]"<<std::endl);
128 bbtkDebugMessage("object",4,
129 " -> Releasing connections"<<std::endl);
130 mConnectionList.clear();
131 bbtkDebugMessage("object",4,
132 " -> Releasing boxes"<<std::endl);
133 mBlackBoxMap.clear();
137 this->bbDesallocateConnectors();
138 if (mLockedDescriptor)
140 bbtkMessage("object",3," --> Releasing descriptor"<<std::endl);
141 mLockedDescriptor.reset();
142 if (!mDescriptor.expired()) BlackBoxDescriptor::Release(mDescriptor);
145 bbtkDebugMessage("object",3,
146 "<== ComplexBlackBox::~ComplexBlackBox() ["
147 <<bbGetName()<<"]"<<std::endl);
149 //=======================================================================
152 //=========================================================================
153 /// Allocates the i/o connectors of the black box
154 void ComplexBlackBox::bbAllocateConnectors()
156 bbtkDebugMessageInc("Kernel",8,
157 "ComplexBlackBox::bbAllocateConnectors() ["
158 <<bbGetFullName()<<"]"
162 const BlackBoxDescriptor::InputDescriptorMapType& imap
163 = bbGetDescriptor()->GetInputDescriptorMap();
164 BlackBoxDescriptor::InputDescriptorMapType::const_iterator i;
165 for ( i = imap.begin(); i != imap.end(); ++i )
167 bbtkDebugMessage("Kernel",8,"* Allocate \""<<i->first<<"\""<<std::endl);
168 // Redirect the connector to the internal box connector
169 // Cast the BBInputDescriptor into a ComplexBBInputDescriptor
170 ComplexBlackBoxInputDescriptor* d =
171 (ComplexBlackBoxInputDescriptor*)i->second;
172 // Get the internal box connector
173 BlackBoxInputConnector* c =
174 bbUnsafeGetBlackBox ( d->GetTarget() )
175 ->bbGetInputConnectorMap()[ d->GetInput() ];
177 bbGetInputConnectorMap()[i->second->GetName()] = c;
178 //new BlackBoxInputConnector();
182 const BlackBoxDescriptor::OutputDescriptorMapType& omap
183 = bbGetDescriptor()->GetOutputDescriptorMap();
184 BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
185 for ( o = omap.begin(); o != omap.end(); ++o )
187 bbtkDebugMessage("Kernel",8,"* Allocate \""<<o->first<<"\""<<std::endl);
188 // Redirect the connector to the internal box connector
189 // Cast the BBOutputDescriptor into a ComplexBBOutputDescriptor
190 ComplexBlackBoxOutputDescriptor* d =
191 (ComplexBlackBoxOutputDescriptor*)o->second;
192 // Get the internal box connector
193 BlackBoxOutputConnector* c =
194 bbUnsafeGetBlackBox ( d->GetTarget() )
195 ->bbGetOutputConnectorMap()[ d->GetOutput() ];
197 bbGetOutputConnectorMap()[o->second->GetName()] = c;
198 //new BlackBoxOutputConnector();
203 bbtkDebugDecTab("Kernel",8);
205 //=========================================================================
208 //=========================================================================
209 /// Desallocates the i/o connectors of the black box
210 void ComplexBlackBox::bbDesallocateConnectors()
212 bbtkDebugMessageInc("Kernel",8,
213 "ComplexBlackBox::DesallocateConnectors()"
216 // The connectors have not been allocated by the complex box
217 // but by the internal boxes. Hence **DO NOT** desallocate !
218 // just clear the maps to avoid that
219 // BlackBox::bbDesallocateConnectors delete the connectors
222 bbGetInputConnectorMap().clear();
223 bbGetOutputConnectorMap().clear();
225 bbtkDebugDecTab("Kernel",8);
228 //=========================================================================
230 //=======================================================================
231 BlackBox::Pointer ComplexBlackBox::bbClone(const std::string& name)
233 bbtkDebugMessageInc("Kernel",9,
234 "ComplexBlackBox::bbClone(\""<<name<<"\") ["
235 <<bbGetFullName()<<"]"<<std::endl);
237 ComplexBlackBox* CBB = new ComplexBlackBox(*this,name);
238 return MakeBlackBoxPointer(CBB);
240 //=======================================================================
242 //=======================================================================
243 /// Main processing method of the box.
244 /// Executes the box so that its outputs are up-to-date on exit
245 void ComplexBlackBox::bbExecute(bool force)
247 bbtkDebugMessageInc("Process",1,
248 "ComplexBlackBox::bbExecute() ["
249 <<bbGetFullName()<<"]"<<std::endl);
252 Wx::BeginBusyCursor();
254 if (mExecutionList.size() != 0)
257 std::vector<std::string>::const_iterator i;
258 for (i=mExecutionList.begin();
259 i!=mExecutionList.end();
262 bbtkDebugMessage("Process",2," -> Executing '"<<*i<<"'"<<std::endl);
263 mBlackBoxMap[*i]->bbExecute(force);
268 std::map<std::string, BlackBox::Pointer>::iterator i;
269 for (i=mBlackBoxMap.begin(); i!=mBlackBoxMap.end(); ++i)
271 i->second->bbExecute(force);
278 bbtkDebugDecTab("Process",1);
281 //==================================================================
283 //==================================================================
284 void ComplexBlackBox::bbSetModifiedStatus(BlackBoxInputConnector* c)
286 bbtkDebugMessage("Process",3,
287 "ComplexBlackBox::bbSetModifiedStatus("
288 <<c<<") ["<<bbGetFullName()<<"]"<<std::endl);
290 c->GetBlackBox()->bbSetModifiedStatus(c);
292 bbtkDebugMessage("Process",3,
293 "EO ComplexBlackBox::bbSetModifiedStatus("
294 <<c<<") ["<<bbGetFullName()<<"]"<<std::endl);
296 //==================================================================
298 //==================================================================
299 void ComplexBlackBox::bbAddToExecutionList( const std::string& name )
301 bbtkDebugMessageInc("Kernel",9,
302 "ComplexBlackBox::bbAddToExecutionList(\""
304 <<bbGetFullName()<<"]"<<std::endl);
306 mExecutionList.push_back( name );
308 bbtkDebugDecTab("Kernel",9);
311 //==================================================================
313 //==================================================================
314 IOStatus ComplexBlackBox::bbBackwardUpdate(Connection::Pointer caller)
316 bbtkDebugMessageInc("Process",1,
317 "ComplexBlackBox::bbBackwardUpdate("
318 <<(caller?caller->GetFullName():"0")<<") ["
319 <<bbGetFullName()<<"]"<<std::endl);
320 bbtkInternalError("ComplexBlackBox::bbBackwardUpdate should never be called !");
324 bbtkInternalError("ComplexBlackBox::bbBackwardUpdate called with caller=0");
327 if (bbGetExecuting())
329 bbtkWarning(bbGetFullName()<<" : Cyclic execution stopped");
332 bbSetExecuting(true);
334 IOStatus s = UPTODATE;
335 const BlackBoxDescriptor::OutputDescriptorMapType& omap
336 = bbGetDescriptor()->GetOutputDescriptorMap();
337 BlackBoxDescriptor::OutputDescriptorMapType::const_iterator i
338 = omap.find(caller->GetBlackBoxFromOutput());
341 // Cast the BBOutputDescriptor into a ComplexBBOutputDescriptor
342 ComplexBlackBoxOutputDescriptor* d =
343 (ComplexBlackBoxOutputDescriptor*)i->second;
344 // Get the internal box
345 BlackBox* b = bbUnsafeGetBlackBox ( d->GetTarget() );
346 // Calls BackwardUpdate on it
347 bbtkDebugMessageInc("Process",2,"Internal box connected to output : "<<d->GetTarget()<<std::endl);
348 // Because internal box can also be a complex box we have to
349 // temporarily change the connection BlackBoxFromOutput to the
352 // std::string oldout = caller->GetBlackBoxFromOutput();
353 // std::cout << "oldout = "<<oldout<<std::endl;
354 // std::cout << "tmpout = "<<d->GetOutput()<<std::endl;
355 // caller->SetBlackBoxFromOutput(d->GetOutput());
357 //Connection newcaller(*caller);
358 //newcaller.SetBlackBoxFromOutput(d->GetOutput());
359 //IOStatus s1 = b->bbBackwardUpdate(&newcaller);
360 IOStatus s1 = b->bbBackwardUpdate(caller);
362 // restore old output
363 // caller->SetBlackBoxFromOutput(oldout);
365 // ??? STATUS OF CBBs ???
366 // ??? Here it is only the final status of the boxes connected to the output
367 if (s1==MODIFIED) s=MODIFIED;
368 bbtkDebugDecTab("Process",2);
372 bbtkError("Connection '"<<caller->GetFullName()<<"' does not point to a valid output of the complex box !");
374 bbtkDebugDecTab("Process",1);
376 bbSetExecuting(false);
382 //==================================================================
385 //==================================================================
386 Data ComplexBlackBox::bbGetOutput( const std::string &name )
388 bbtkDebugMessageInc("Data",7,
389 "ComplexBlackBox::bbGetOutput(\""<<name<<"\") ["
390 <<bbGetFullName()<<"]"<<std::endl);
392 ComplexBlackBoxOutputDescriptor* d =
393 (ComplexBlackBoxOutputDescriptor*)
394 bbGetDescriptor()->GetOutputDescriptor(name);
396 Data p = bbGetBlackBox(d->GetTarget())->bbGetOutput(d->GetOutput());
399 bbtkDebugDecTab("Data",7);
402 //==================================================================
404 //==================================================================
405 /// Gets the input Data of a given name
406 Data ComplexBlackBox::bbGetInput( const std::string &name )
408 bbtkDebugMessageInc("Data",7,
409 "ComplexBlackBox::bbGetInput(\""<<name<<"\") ["
410 <<bbGetFullName()<<"]"<<std::endl);
412 ComplexBlackBoxInputDescriptor* d =
413 (ComplexBlackBoxInputDescriptor*)
414 bbGetDescriptor()->GetInputDescriptor(name);
416 Data p = bbGetBlackBox(d->GetTarget())->bbGetInput(d->GetInput());
418 bbtkDebugDecTab("Data",7);
421 //==================================================================
423 //==================================================================
424 /// Sets the data of the output called <name>
425 void ComplexBlackBox::bbSetOutput( const std::string &name, Data data)
427 bbtkDebugMessageInc("Data",7,
428 "ComplexBlackBox::bbSetOutput(\""<<name<<"\",data) ["
429 <<bbGetFullName()<<"]"<<std::endl);
431 ComplexBlackBoxOutputDescriptor* d =
432 (ComplexBlackBoxOutputDescriptor*)
433 bbGetDescriptor()->GetOutputDescriptor(name);
435 bbGetBlackBox(d->GetTarget())->bbSetOutput(d->GetOutput(),data);
437 bbtkDebugDecTab("Data",7);
439 //==================================================================
441 //==================================================================
442 /// Sets the data of the input called <name>
443 void ComplexBlackBox::bbSetInput( const std::string &name, Data data,
446 bbtkDebugMessageInc("Data",7,
447 "ComplexBlackBox::bbSetInput(\""<<name<<"\",data) ["
448 <<bbGetFullName()<<"]"<<std::endl);
450 ComplexBlackBoxInputDescriptor* d = (ComplexBlackBoxInputDescriptor*)
451 bbGetDescriptor()->GetInputDescriptor(name);
453 bbGetBlackBox(d->GetTarget())->bbSetInput(d->GetInput(),data,setModified);
455 bbtkDebugDecTab("Data",7);
457 //==================================================================
460 //==================================================================
461 /// Sets the data of the input called <name>
462 void ComplexBlackBox::bbBruteForceSetInputPointer( const std::string &name,
466 bbtkDebugMessageInc("Data",7,
467 "ComplexBlackBox::bbBruteForceSetInputPointer('"
468 <<name<<"',"<<data<<") ["
469 <<bbGetFullName()<<"]"<<std::endl);
471 ComplexBlackBoxInputDescriptor* d = (ComplexBlackBoxInputDescriptor*)
472 bbGetDescriptor()->GetInputDescriptor(name);
474 bbGetBlackBox(d->GetTarget())->bbBruteForceSetInputPointer(d->GetInput(),
478 bbtkDebugDecTab("Data",7);
480 //==================================================================
482 //=========================================================================
483 /// Connects the input <name> to the connection c
484 void ComplexBlackBox::bbConnectInput( const std::string& name, Connection::Pointer c)
486 bbtkDebugMessageInc("Kernel",7,
487 "ComplexBlackBox::bbConnectInput(\""
488 <<name<<"\","<<c<<") ["
489 <<bbGetFullName()<<"]"
492 ComplexBlackBoxInputDescriptor* d = (ComplexBlackBoxInputDescriptor*)
493 bbGetDescriptor()->GetInputDescriptor(name);
495 BlackBox::Pointer t = bbGetBlackBox(d->GetTarget());
497 c->SetBlackBoxToInput(d->GetInput());
498 t->bbConnectInput(d->GetInput(),c);
500 bbtkMessage("Debug",1,"ComplexBlackBox["<<bbGetFullName()<<"]::bbConnectInput : "
501 <<c->GetFullName()<<std::endl);
503 bbtkDebugDecTab("Kernel",7);
505 //=========================================================================
508 //=========================================================================
509 /// Connects the output <name> to the connection c
510 void ComplexBlackBox::bbConnectOutput( const std::string& name, Connection::Pointer c)
512 bbtkDebugMessageInc("Kernel",7,
513 "ComplexBlackBox::bbConnectOutput(\""
514 <<name<<"\","<<c<<") ["
515 <<bbGetFullName()<<"]"<<std::endl);
517 ComplexBlackBoxOutputDescriptor* d = (ComplexBlackBoxOutputDescriptor*)
518 bbGetDescriptor()->GetOutputDescriptor(name);
520 BlackBox::Pointer t = bbGetBlackBox(d->GetTarget());
522 c->SetBlackBoxFrom(t);
523 c->SetBlackBoxFromOutput(d->GetOutput());
524 t->bbConnectOutput(d->GetOutput(),c);
526 bbtkMessage("Debug",5,"ComplexBlackBox["<<bbGetFullName()<<"]::bbConnectOutput : "
527 <<c->GetFullName()<<std::endl);
529 bbtkDebugDecTab("Kernel",7);
531 //=========================================================================
534 //==================================================================
535 /// Adds the black box to the complex box
536 void ComplexBlackBox::bbAddBlackBox( BlackBox::Pointer b)
538 bbtkDebugMessageInc("Kernel",7,
539 "ComplexBlackBox::AddBlackBox(\""<<b->bbGetName()
541 <<bbGetFullName()<<"]"<<std::endl);
543 if ( bbUnsafeGetBlackBox(b->bbGetName()) )
545 bbtkError("a black box called \""<<b->bbGetName()
546 <<"\" already exists");
548 b->bbSetParent(GetThisPointer<ComplexBlackBox>());
549 mBlackBoxMap[b->bbGetName()] = b;
551 bbtkDebugDecTab("Kernel",7);
553 //==================================================================
555 //==================================================================
556 /// Adds the black box to the complex box (unsafe)
557 void ComplexBlackBox::bbUnsafeAddBlackBox( BlackBox::Pointer b)
559 bbtkDebugMessageInc("Kernel",7,
560 "ComplexBlackBox::UnsafeAddBlackBox(\""<<b->bbGetName()
562 <<bbGetFullName()<<"]"<<std::endl);
564 b->bbSetParent(GetThisPointer<ComplexBlackBox>());
565 mBlackBoxMap[b->bbGetName()] = b;
567 bbtkDebugDecTab("Kernel",7);
569 //==================================================================
571 //==================================================================
572 /// Removes the black box from the complex box
573 void ComplexBlackBox::bbRemoveBlackBox( const std::string& name,
574 bool remove_connections )
576 bbtkDebugMessageInc("Kernel",7,
577 "ComplexBlackBox::RemoveBlackBox(\""<<name<<"\") ["
578 <<bbGetFullName()<<"]"<<std::endl);
580 BlackBoxMapType::iterator i = mBlackBoxMap.find(name);
581 if ( i == mBlackBoxMap.end() )
583 bbtkError("the black box \""<<name<<"\" does not exist");
585 BlackBox::WeakPointer p = i->second;
587 if (remove_connections)
589 ConnectionListType::const_iterator j;
590 for ( j = mConnectionList.begin();
591 j != mConnectionList.end(); ++j )
596 if (p.use_count()!=1)
598 bbtkError("the black box \""<<name<<"\" is still connected");
601 mBlackBoxMap.erase(i);
604 // Unload orphan dl packages
605 Package::UnLoadReleasedDynamicallyLoadedPackages();
607 bbtkDebugDecTab("Kernel",7);
609 //==================================================================
611 //==================================================================
612 /// Adds the connection to the complex box
613 void ComplexBlackBox::bbAddConnection( Connection::Pointer c)
615 bbtkDebugMessageInc("Kernel",7,
616 "ComplexBlackBox::AddConnection(\""<<"..."<<"\") ["
617 <<bbGetFullName()<<"]"<<std::endl);
619 mConnectionList.push_back(c);
621 bbtkDebugDecTab("Kernel",7);
623 //==================================================================
624 // void RemoveConnection( );
626 //==================================================================
627 /// Returns the black box with name <name>
628 BlackBox::Pointer ComplexBlackBox::bbGetBlackBox( const std::string& name )
630 bbtkDebugMessageInc("Kernel",9,
631 "ComplexBlackBox::GetBlackBox(\""<<name<<"\") ["
632 <<bbGetFullName()<<"]"<<std::endl);
634 BlackBoxMapType::iterator i = mBlackBoxMap.find(name);
635 if ( i == mBlackBoxMap.end() )
637 bbtkError("the black box \""<<name<<"\" does not exist");
640 bbtkDebugDecTab("Kernel",9);
643 //==================================================================
645 //==================================================================
646 /// Returns the black box with name <name> : does not throw an exception
647 /// if it does not exist but return a null pointer
648 BlackBox::Pointer ComplexBlackBox::bbUnsafeGetBlackBox( const std::string& name )
650 bbtkDebugMessageInc("Kernel",9,
651 "ComplexBlackBox::UnsafeGetBlackBox(\""<<name<<"\") ["
652 <<bbGetFullName()<<"]"
655 BlackBoxMapType::iterator i = mBlackBoxMap.find(name);
656 if ( i == mBlackBoxMap.end() )
658 bbtkDebugDecTab("Kernel",9);
659 return BlackBox::Pointer();
662 bbtkDebugDecTab("Kernel",9);
666 //==================================================================
668 //==================================================================
669 void ComplexBlackBox::bbPrintBlackBoxes()
671 bbtkDebugMessageInc("Kernel",9,
672 "ComplexBlackBox::PrintBlackBoxes() ["
673 <<bbGetFullName()<<"]"
676 BlackBoxMapType::iterator i;
677 for ( i = mBlackBoxMap.begin(); i != mBlackBoxMap.end(); ++i )
679 bbtkMessage("Help",1,i->second->bbGetFullName()<<std::endl);
682 bbtkDebugDecTab("Kernel",9);
684 //==================================================================
688 //=========================================================================
690 void ComplexBlackBox::bbWriteDotInputOutputName(FILE *ff,bool inputoutput,int detail, int level)
694 fprintf(ff,"%s_IN_%p",bbGetTypeName().c_str(),this);
696 fprintf(ff,"%s_OUT_%p",bbGetTypeName().c_str(),this);
699 //=========================================================================
702 //=========================================================================
703 BlackBox::Pointer ComplexBlackBox::bbFindBlackBox(const std::string &blackboxname)
705 BlackBox::Pointer blackbox;
706 std::string subname="";
707 std::string restname="";
708 std::string delimiters(">");
709 // Skip delimiters at beginning.
710 std::string::size_type lastPos = blackboxname.find_first_not_of(delimiters, 0);
711 // Find first "non-delimiter".
712 std::string::size_type pos = blackboxname.find_first_of(delimiters, lastPos);
714 // Found a token, add it to the vector.
715 subname = blackboxname.substr(lastPos, pos - lastPos);
716 restname = blackboxname.substr(lastPos+pos - lastPos+1, 999);
718 if (restname==subname)
723 BlackBoxMapType::iterator i = mBlackBoxMap.find(subname);
724 if ( i != mBlackBoxMap.end() )
726 blackbox = i->second;
729 blackbox = blackbox->bbFindBlackBox(restname);
734 //=========================================================================
736 //=========================================================================
737 void ComplexBlackBox::bbInsertHTMLGraph( std::ofstream& s,
741 const std::string& output_dir,
745 std::string directory(output_dir);
747 if (output_dir.length() == 0)
749 // Don't pollute the file store with "temp_dir" directories ...
750 std::string default_temp_dir = ConfigurationFile::GetInstance().Get_default_temp_dir();
751 directory = default_temp_dir + "/" + "temp_dir";
754 std::string simplefilename (this->bbGetTypeName()+"_"+this->bbGetName());
755 std::string simplefilename_png (simplefilename+".png");
756 std::string filename (directory+"/"+simplefilename);
757 std::string filename_png (filename+".png");
758 std::string filename_cmap (filename+".cmap");
759 std::string filename_dot (filename+".dot");
761 std::string filename_png2 ("\"" + filename_png + "\"");
762 std::string filename_cmap2 ("\"" + filename_cmap + "\"");
763 std::string filename_dot2 ("\"" + filename_dot + "\"");
766 std::string command1 ("dot -T png -o "
767 + filename_png2 + " " + filename_dot2);
768 std::string command1a("dot -T cmap -o "
769 + filename_cmap2 + " " + filename_dot2);
771 // 1. Generating .dot file
773 ff = fopen(filename_dot.c_str(),"w");
774 fprintf(ff,"digraph bbtk_graph{\n");
775 fprintf(ff,"rankdir=LR%s\n",";");
776 fprintf(ff,"node [shape=record]%s\n",";");
778 this->bbWriteDotFileBlackBox(ff,
779 GetThisPointer<ComplexBlackBox>(),
787 // 2. Executing .dot file -> png
788 system( command1.c_str() );
789 // 3. Executing .dot file -> cmap
790 system( command1a.c_str() );
792 // 4. HTML code insertion
794 (s) << "<center><img src=\"" << simplefilename_png
795 << "\" border=\"0\" usemap=\"#map_"<< simplefilename
796 <<"\" alt=\"\"></center>\n";
799 (s) << "<map name=\"map_"<< simplefilename <<"\">\n";
802 ff2=fopen(filename_cmap.c_str(),"r");
815 //=========================================================================
818 //=========================================================================
819 /// Write Graphviz-dot description in file
820 void ComplexBlackBox::bbWriteDotFileBlackBox(FILE *ff,
821 BlackBox::Pointer parentblackbox,
822 int detail, int level,
827 std::string valueStr("");
828 Package::Pointer package = this->bbGetDescriptor()->GetPackage();
833 tmp1 = this->bbGetDescriptor()->GetPackage()->GetDocRelativeURL();
835 tmp1 = this->bbGetDescriptor()->GetPackage()->GetDocURL();
842 std::string tmp2=bbGetTypeName();
843 std::string url(tmp1 + "#" + tmp2 );
844 fprintf( ff , "subgraph cluster_%s_%p {\n",bbGetName().c_str(),this);
846 if (!( (bbGetTypeName()=="workspace") && (bbGetName()=="workspacePrototype")) )
848 fprintf( ff , " URL = \"%s\" %s",url.c_str(),";");
851 std::string boxname="["+bbGetTypeName()+"]";
852 if (GetThisPointer<ComplexBlackBox>()!=parentblackbox)
860 boxname = bbGetName();
861 boxname = boxname + " [" +this->bbGetDescriptor()->GetPackage()->GetName()+"::"+ bbGetTypeName() + "]";
865 fprintf( ff , " label = \"%s\"%s\n", boxname.c_str() ,";");
869 // fprintf( ff , " style=filled%s\n",";");
870 // fprintf( ff , " color=grey%s\n",";");
871 fprintf( ff , " node [style=filled]%s\n",";");
872 fprintf( ff , " fillcolor=grey%s\n",";");
873 fprintf( ff , " edge [color=blue]%s\n",";");
877 std::string labelStr1;
878 std::string labelStr2;
879 labelStr1 = boxname + "\\n(output)" ;
880 labelStr2 = " | {{ ";
883 OutputConnectorMapType::iterator i;
885 const BlackBoxDescriptor::OutputDescriptorMapType& omap = this->bbGetDescriptor()->GetOutputDescriptorMap();
886 BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
887 for ( o = omap.begin(); o != omap.end(); ++o )
891 labelStr2=labelStr2+" | ";
894 if (instanceOrtype==true)
896 valueStr = this->bbGetOutputAsString(o->second->GetName()/*
899 labelStr2=labelStr2+"<"+o->second->GetName().c_str()+"> " + valueStr + o->second->GetName().c_str();
902 labelStr2 = labelStr2+ " } }";
908 labelStr1 = labelStr1 + labelStr2;
913 bbWriteDotInputOutputName(ff,false,detail,level);
914 fprintf( ff , " [shape=record, style=filled,fillcolor=grey,color=red,label=\"%s\"]%s\n",labelStr1.c_str(),";" );
919 labelStr1 = boxname + "\\n(input)" ;
920 labelStr2 = " | {{ ";
922 InputConnectorMapType::iterator ii;
924 const BlackBoxDescriptor::InputDescriptorMapType& imap = this->bbGetDescriptor()->GetInputDescriptorMap();
925 BlackBoxDescriptor::InputDescriptorMapType::const_iterator iii;
926 for ( iii = imap.begin(); iii != imap.end(); ++iii )
930 labelStr2=labelStr2+" | ";
933 if (instanceOrtype==true)
935 valueStr = this->bbGetInputAsString(iii->second->GetName()/*,factory*/) + " = ";
937 labelStr2=labelStr2+"<"+iii->second->GetName().c_str()+"> " + valueStr + iii->second->GetName().c_str();
941 labelStr2 = labelStr2+ " } }";
944 labelStr1 = labelStr1 + labelStr2;
948 bbWriteDotInputOutputName(ff,true,detail,level);
949 fprintf( ff , " [shape=record, style=filled,fillcolor=grey,color=red,label=\"%s\"]%s\n",labelStr1.c_str(),";" );
954 BlackBoxMapType::iterator j;
955 for ( j = mBlackBoxMap.begin(); j != mBlackBoxMap.end(); ++j )
959 j->second->bbWriteDotFileBlackBox(ff,
968 fprintf( ff , "}\n\n");
970 fprintf( ff , " edge[color=blue]%s\n",";");
974 // Relation Input with the inside BlackBox of the this ComplexBlackbox
975 ComplexBlackBoxDescriptor::InputDescriptorMapType::iterator xx;
976 ComplexBlackBoxDescriptor::InputDescriptorMapType idmt=bbGetDescriptor()->GetInputDescriptorMap();
977 for ( xx = idmt.begin(); xx != idmt.end(); ++xx )
979 ComplexBlackBoxInputDescriptor *cbbid = (ComplexBlackBoxInputDescriptor*)xx->second;
982 bbWriteDotInputOutputName(ff,true,detail,level);
985 fprintf(ff,":%s",cbbid->GetName().c_str() );
988 BlackBox::Pointer bb = bbGetBlackBox( cbbid->GetTarget() );
989 bb->bbWriteDotInputOutputName(ff,true,detail,level);
992 fprintf(ff,":%s \n", cbbid->GetInput().c_str() );
1002 // Relation Output ComplexBlackBox
1003 ComplexBlackBoxDescriptor::OutputDescriptorMapType::iterator yy;
1004 ComplexBlackBoxDescriptor::OutputDescriptorMapType odmt=bbGetDescriptor()->GetOutputDescriptorMap();
1005 for ( yy = odmt.begin(); yy != odmt.end(); ++yy )
1007 ComplexBlackBoxOutputDescriptor *cbbod = (ComplexBlackBoxOutputDescriptor*)yy->second;
1009 BlackBox::Pointer bb = bbGetBlackBox( cbbod->GetTarget() );
1010 bb->bbWriteDotInputOutputName(ff,false,detail,level);
1013 fprintf(ff,":%s", cbbod->GetOutput().c_str() );
1016 bbWriteDotInputOutputName(ff,false,detail,level);
1019 fprintf(ff,":%s",cbbod->GetName().c_str() );
1028 // Relation from the out side of this ComplexBlackBox with its Inputs
1029 if (GetThisPointer<ComplexBlackBox>()!=parentblackbox) {
1030 for ( ii = bbGetInputConnectorMap().begin();
1031 ii != bbGetInputConnectorMap().end(); ++ii )
1035 Connection::Pointer con = ii->second->GetConnection();
1037 BlackBox::Pointer a=con->GetBlackBoxFrom();
1038 BlackBox::Pointer b=con->GetBlackBoxTo();
1040 a->bbWriteDotInputOutputName(ff,false,detail,level);
1043 fprintf(ff,":%s",con->GetBlackBoxFromOutput().c_str());
1046 b->bbWriteDotInputOutputName(ff,true,detail,level);
1049 fprintf(ff,":%s",con->GetBlackBoxToInput().c_str());
1051 fprintf(ff,"%s\n",";");
1055 } // if parentblackbox
1057 //=========================================================================
1064 //=======================================================================
1065 /// Generates the list of the packages of which its depends
1066 /// (cause an internal box belongs to it)
1067 void ComplexBlackBox::GetPackagesDependencies(std::vector<Package*>& deps)
1070 BlackBoxMapType::iterator i;
1071 for ( i = mBlackBoxMap.begin(); i != mBlackBoxMap.end(); ++i )
1073 deps.push_back(i->second->bbGetDescriptor()->GetPackage());
1077 //=======================================================================
1080 //=======================================================================
1081 void ComplexBlackBox::Check(bool recursive)
1083 bbtkMessage("Debug",1,"**** Checking Complex Black Box "<<(void*)this
1084 <<" ["<<bbGetFullName()<<"]"<<std::endl);
1086 BlackBoxMapType::const_iterator i;
1087 for ( i = mBlackBoxMap.begin(); i != mBlackBoxMap.end(); ++i )
1089 i->second->Check(recursive);
1091 ConnectionListType::const_iterator j;
1092 for ( j = mConnectionList.begin();
1093 j != mConnectionList.end(); ++j )
1097 bbtkMessage("Debug",1,"**** Checking Complex Black Box "<<(void*)this
1098 <<" ["<<bbGetFullName()<<"] ... OK"<<std::endl);
1101 //=======================================================================
1103 //=========================================================================
1104 /// Returns the name with the name of the parent prepended if any
1105 std::string ComplexBlackBox::bbGetNameWithParent() const
1107 if (!IsAPrototype()) return BlackBox::bbGetNameWithParent();
1108 if (bbGetDescriptor())
1110 return bbGetDescriptor()->GetFullTypeName() + ":" + bbGetName();
1114 return std::string(":") + bbGetName();
1117 //=========================================================================
1119 //==========================================================================
1120 std::string ComplexBlackBox::GetObjectName() const
1122 return std::string("ComplexBlackBox '")+bbGetNameWithParent()
1125 //==========================================================================
1127 //==========================================================================
1128 std::string ComplexBlackBox::GetObjectInfo() const
1130 std::stringstream i;
1131 i << " - "<<mBlackBoxMap.size() << " boxes / "
1132 <<mConnectionList.size() << " connections" << std::endl;
1135 //==========================================================================
1137 //==========================================================================
1138 size_t ComplexBlackBox::GetObjectSize() const
1140 size_t s = Superclass::GetObjectSize();
1141 s += ComplexBlackBox::GetObjectInternalSize();
1144 //==========================================================================
1145 //==========================================================================
1146 size_t ComplexBlackBox::GetObjectInternalSize() const
1148 size_t s = sizeof(ComplexBlackBox);
1151 //==========================================================================
1152 //==========================================================================
1153 size_t ComplexBlackBox::GetObjectRecursiveSize() const
1155 size_t s = Superclass::GetObjectRecursiveSize();
1156 s += ComplexBlackBox::GetObjectInternalSize();
1157 BlackBoxMapType::const_iterator i;
1158 for ( i = mBlackBoxMap.begin(); i != mBlackBoxMap.end(); ++i )
1160 s += i->second->GetObjectRecursiveSize();
1162 ConnectionListType::const_iterator j;
1163 for ( j = mConnectionList.begin();
1164 j != mConnectionList.end(); ++j )
1166 s += (*j)->GetObjectRecursiveSize();
1170 //==========================================================================