2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
10 # This software is governed by the CeCILL-B license under French law and
11 # abiding by the rules of distribution of free software. You can use,
12 # modify and/ or redistribute the software under the terms of the CeCILL-B
13 # license as circulated by CEA, CNRS and INRIA at the following URL
14 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 # or in the file LICENSE.txt.
17 # As a counterpart to the access to the source code and rights to copy,
18 # modify and redistribute granted by the license, users are provided only
19 # with a limited warranty and the software's author, the holder of the
20 # economic rights, and the successive licensors have only limited
23 # The fact that you are presently reading this means that you have had
24 # knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ */
28 /*=========================================================================
30 Module: $RCSfile: bbtkBlackBox.cxx,v $
32 Date: $Date: 2012/11/16 08:49:01 $
33 Version: $Revision: 1.56 $
34 =========================================================================*/
40 * \brief Class bbtk::BlackBox : abstract black-box interface.
42 #include "bbtkBlackBox.h"
43 #include "bbtkPackage.h"
44 #include "bbtkMessageManager.h"
45 #include "bbtkFactory.h"
46 #include "bbtkBlackBoxOutputConnector.h"
48 #include "bbtkConfigurationFile.h"
49 #include "bbtkWxBlackBox.h"
58 static bool bbmgSomeBoxExecuting = false;
59 static bool bbmgFreezeExecution = false;
60 static std::set<BlackBox::WeakPointer> bbmgExecutionList;
62 //=========================================================================
64 BlackBox::Deleter::Deleter()
67 //=========================================================================
69 //=========================================================================
70 int BlackBox::Deleter::Delete(Object* p)
72 BlackBox* b = dynamic_cast<BlackBox*>(p);
75 bbtkInternalError("BlackBox::Deleter::Delete("<<p->GetObjectName()
77 <<"dynamic cast to BlackBox* failed !");
79 std::string name = p->GetObjectName();//b->bbGetNameWithParent();
80 bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\")"<<std::endl);
83 BlackBoxDescriptor::WeakPointer desc = b->bbGetDescriptor();
84 bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : deleting black box"<<std::endl);
86 int refs = b->bbDelete();
88 bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : releasing descriptor"<<std::endl);
92 Package::WeakPointer pack = desc.lock()->GetPackage();
95 Package::ReleaseBlackBoxDescriptor(pack,desc);
97 bbtkDebugMessage("object",2,"##> BlackBox::Deleter(\""<<name<<"\") : descriptor package expired (was not held by a package and the box was the last instance)"<<std::endl);
100 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);
102 bbtkDebugMessage("object",2,"<## BlackBox::Deleter(\""<<name<<"\")"<<std::endl);
105 //=========================================================================
107 //=========================================================================
108 BlackBox::BlackBox(const std::string &name)
110 // bbmStatus(MODIFIED),
111 bbmInitialized(false),
114 bbmBoxProcessMode("Pipeline"),
115 bbLetRecursiveExecuteManualMode(false),
120 // bbmBoxProcessMode = "Pipeline";
121 //std::cout<<"JCP BlackBox::BlackBox(const std::string &name) name=" <<name
122 // <<"bbmBoxProcessMode="<<bbmBoxProcessMode<<std::endl;
123 bbtkBlackBoxDebugMessage("object",4,"==> BlackBox::BlackBox(\""
124 <<name<<"\")"<<std::endl);
125 bbtkBlackBoxDebugMessage("object",4,"<== BlackBox::BlackBox(\""
126 <<name<<"\")"<<std::endl);
128 //=========================================================================
130 //=========================================================================
131 BlackBox::BlackBox(const BlackBox&)
134 //=========================================================================
135 BlackBox::BlackBox(BlackBox& from, const std::string &name)
137 // bbmStatus(from.bbmStatus),
138 bbmInitialized(false),
141 bbmBoxProcessMode(from.bbmBoxProcessMode),
142 bbLetRecursiveExecuteManualMode(false),
147 //bbmBoxProcessMode = from.bbmBoxProcessMode;
148 //std::cout<<"JCP BlackBox::BlackBox(const std::string &name) name=" <<name
149 // <<"bbmBoxProcessMode="<<bbmBoxProcessMode<<std::endl;
150 bbtkBlackBoxDebugMessage("object",4,"==> BlackBox::BlackBox("
151 <<from.bbGetFullName()<<",\""
152 <<name<<"\")"<<std::endl);
153 bbtkBlackBoxDebugMessage("object",4,"<== BlackBox::BlackBox("
154 <<from.bbGetFullName()<<",\""
155 <<name<<"\")"<<std::endl);
157 //=========================================================================
160 //=========================================================================
161 BlackBox::~BlackBox()
163 bbtkBlackBoxDebugMessage("object",4,"==> BlackBox::~BlackBox() ["<<bbmName
165 this->bbDesallocateConnectors();
166 bbtkBlackBoxDebugMessage("object",4,"<== BlackBox::~BlackBox() ["<<bbmName
169 //=========================================================================
173 //=========================================================================
174 std::string BlackBox::bbGetFullName() const
176 return this->bbGetNameWithParent()+"<"+this->bbGetDescriptor()->GetTypeName()+">";
178 //=========================================================================
182 //=========================================================================
183 std::string BlackBox::bbGetNameWithParent() const
185 if (bbmParent.lock())
187 return bbmParent.lock()->bbGetNameWithParent() + ":" + bbmName;
192 //=========================================================================
194 //=========================================================================
195 void BlackBox::bbGetHelp(bool full) const
197 bbGetDescriptor()->GetHelp(full);
199 //=========================================================================
202 //=========================================================================
203 bool BlackBox::bbHasInput(const std::string& name) const
205 bbtkBlackBoxDebugMessage("kernel",8,
206 "BlackBox::bbHasInput(\""
209 bool r = ( bbGetDescriptor()->GetInputDescriptorMap().find(name)
210 != bbGetDescriptor()->GetInputDescriptorMap().end());
211 bbtkDebugDecTab("kernel",8);
214 //=========================================================================
217 //=========================================================================
218 bool BlackBox::bbHasOutput(const std::string& name) const
220 bbtkBlackBoxDebugMessage("kernel",8,"BlackBox::bbHasOutput(\""
223 bool r = ( bbGetDescriptor()->GetOutputDescriptorMap().find(name)
224 != bbGetDescriptor()->GetOutputDescriptorMap().end());
225 bbtkDebugDecTab("kernel",8);
228 //=========================================================================
231 //=========================================================================
232 TypeInfo BlackBox::bbGetOutputType( const std::string &name ) const
234 bbtkBlackBoxDebugMessage("kernel",8,
235 "BlackBox::bbGetOutputType(\""
238 TypeInfo r = bbGetDescriptor()->GetOutputDescriptor(name)->GetTypeInfo();
239 bbtkDebugDecTab("kernel",8);
242 //=========================================================================
244 //=========================================================================
245 TypeInfo BlackBox::bbGetInputType( const std::string &name ) const
247 bbtkBlackBoxDebugMessage("kernel",8,
248 "BlackBox::bbGetInputType(\""
251 TypeInfo r = bbGetDescriptor()->GetInputDescriptor(name)->GetTypeInfo();
252 bbtkDebugDecTab("kernel",8);
255 //=========================================================================
258 //=========================================================================
259 void BlackBox::bbAllocateConnectors()
261 bbtkBlackBoxDebugMessage("kernel",8,
262 "BlackBox::bbAllocateConnectors()"
265 MakeBlackBoxPointer(this,true);
267 const BlackBoxDescriptor::InputDescriptorMapType& imap
268 = bbGetDescriptor()->GetInputDescriptorMap();
269 BlackBoxDescriptor::InputDescriptorMapType::const_iterator i;
270 for ( i = imap.begin(); i != imap.end(); ++i )
272 bbtkBlackBoxDebugMessage("kernel",8,"* Allocate \""<<i->first<<"\""<<std::endl);
273 bbGetInputConnectorMap()[i->second->GetName()]
274 = new BlackBoxInputConnector(GetThisPointer<BlackBox>());
276 const BlackBoxDescriptor::OutputDescriptorMapType& omap
277 = bbGetDescriptor()->GetOutputDescriptorMap();
278 BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
279 for ( o = omap.begin(); o != omap.end(); ++o )
281 bbtkBlackBoxDebugMessage("kernel",8,"* Allocate \""<<o->first<<"\""<<std::endl);
282 bbGetOutputConnectorMap()[o->second->GetName()]
283 = new BlackBoxOutputConnector(GetThisPointer<BlackBox>());
286 //=========================================================================
289 //=========================================================================
290 void BlackBox::bbDesallocateConnectors()
292 bbtkBlackBoxDebugMessage("kernel",8,
293 "BlackBox::bbDesallocateConnectors()"
296 InputConnectorMapType::const_iterator i;
297 for ( i = bbGetInputConnectorMap().begin();
298 i != bbGetInputConnectorMap().end(); ++i )
300 bbtkBlackBoxDebugMessage("kernel",8,"* Delete \""<<i->first<<"\""<<std::endl);
303 OutputConnectorMapType::const_iterator o;
304 for ( o = bbGetOutputConnectorMap().begin();
305 o != bbGetOutputConnectorMap().end(); ++o )
307 bbtkBlackBoxDebugMessage("kernel",8,"* Delete \""<<o->first<<"\""<<std::endl);
311 bbtkDebugDecTab("kernel",8);
313 //=========================================================================
316 //=========================================================================
317 void BlackBox::bbCopyIOValues(BlackBox& from)
319 bbtkBlackBoxDebugMessage("kernel",1,
320 "BlackBox::bbCopyIOValues("
321 <<from.bbGetFullName()<<")"
323 // copies the input values
324 const BlackBoxDescriptor::InputDescriptorMapType& imap
325 = bbGetDescriptor()->GetInputDescriptorMap();
326 BlackBoxDescriptor::InputDescriptorMapType::const_iterator i;
327 for ( i = imap.begin(); i != imap.end(); ++i )
329 if (! i->second->GetCopyConstruct() ) continue;
330 std::string input = i->second->GetName();
331 bbtkBlackBoxDebugMessage("kernel",2,"* Copying input "<<input<<std::endl);
332 this->bbSetInput(input, from.bbGetInput(input) );
334 // copies the output values
335 const BlackBoxDescriptor::OutputDescriptorMapType& omap
336 = bbGetDescriptor()->GetOutputDescriptorMap();
337 BlackBoxDescriptor::OutputDescriptorMapType::const_iterator o;
338 for ( o = omap.begin(); o != omap.end(); ++o )
340 if (! o->second->GetCopyConstruct() ) continue;
341 std::string output = o->second->GetName();
342 bbtkBlackBoxDebugMessage("kernel",2,"* Copying output "<<output<<std::endl);
343 this->bbSetOutput(output, from.bbGetOutput(output) );
346 bbtkDebugDecTab("kernel",9);
348 //=========================================================================
352 //=========================================================================
353 bool BlackBox::bbCanReact() const
355 return ( bbGlobalGetSomeBoxExecuting()
357 || Wx::IsSomeWindowAlive()
361 //=========================================================================
365 //=========================================================================
366 BlackBox::BoxProcessModeValue BlackBox::bbGetBoxProcessModeValue() const
368 const std::string& p = bbmBoxProcessMode;
370 (p == "P") || (p == "p") ||
371 (p == "Pipeline") || (p == "pipeline") ) return bbPipeline;
373 (p == "A") || (p == "a") ||
374 (p == "Always") || (p == "always") ) return bbAlways;
376 (p == "R") || (p == "r") ||
377 (p == "Reactive") || (p == "reactive") )
381 (p == "F") || (p == "f") ||
382 (p == "Flash") || (p == "flash") ) return Flash;
386 (p == "M") || (p == "m") ||
387 (p == "Manual") || (p == "manual") ) return bbManual;
389 bbtkError(bbGetFullName()<<" : BoxProcessMode value '"<<p
390 <<"' unknown. Possible values : "
391 <<"'0'/'P'/'p'/'Pipeline'/'pipeline' | "
392 <<"'1'/'A'/'a'/'Always'/'always' | "
393 <<"'2'/'R'/'r'/'Reactive'/'reactive'"
394 // <<"'3'/'F'/'f'/'Flash'/'flash'"
395 <<"'3'/'M'/'m'/'Manual'/'manual'"
398 //=========================================================================
400 //=========================================================================
401 bool BlackBox::bbBoxProcessModeIsReactive() const
403 return (bbGetBoxProcessModeValue() == bbReactive);
405 //=========================================================================
407 //=========================================================================
408 bool BlackBox::bbBoxProcessModeIsAlways() const
410 return (bbGetBoxProcessModeValue() == bbAlways);
412 //=========================================================================
415 //=========================================================================
416 bool BlackBox::bbBoxProcessModeIsManual() const
418 return (bbGetBoxProcessModeValue() == bbManual);
420 //=========================================================================
423 //=========================================================================
424 void BlackBox::bbAddOutputObserver(const std::string& output,
425 OutputChangeCallbackType f)
427 bbGetOutputConnector(output).AddChangeObserver(f);
429 //=========================================================================
431 //=========================================================================
432 void BlackBox::bbRemoveOutputObserver(const std::string& output_name,
433 OutputChangeCallbackType f)
435 bbtkError("BlackBox::RemoveChangeObserver NOT IMPLEMENTED");
437 //=========================================================================
440 //=========================================================================
441 void BlackBox::bbSetStatusAndPropagate(BlackBoxInputConnector* c,
444 bbtkBlackBoxDebugMessage("change",5,
445 "=> BlackBox::bbSetStatusAndPropagate(input,"
446 <<GetIOStatusString(s)<<")"
449 if (s==UPTODATE) bbtkError("bbSetStatusAndPropagate with status UPTODATE!");
454 if (bbGetBoxProcessModeValue() == Flash)
461 OutputConnectorMapType::const_iterator o;
462 for ( o = bbGetOutputConnectorMap().begin();
463 o != bbGetOutputConnectorMap().end(); ++o )
467 if (o->first=="BoxChange")
469 o->second->SetStatus(UPTODATE);
476 if (o->second->GetStatus()==UPTODATE)
477 // if ((o->second->GetStatus()==UPTODATE) || (o->second->GetStatus()==OUTOFDATE))
478 // if ((o->second->GetStatus()==UPTODATE) || (o->second->GetStatus()==MODIFIED))
480 o->second->SetStatus(OUTOFDATE);
481 o->second->SignalChange(GetThisPointer<BlackBox>(),o->first);
486 if ( ( bbBoxProcessModeIsReactive()
487 || (c==bbGetInputConnectorMap().find("BoxExecute")->second))
490 bbtkBlackBoxDebugMessage("change",2,
491 "-> Execution triggered by Reactive mode or BoxExecute input change"<<std::endl);
492 bbGlobalAddToExecutionList( GetThisPointer<BlackBox>() );
494 bbtkBlackBoxDebugMessage("change",5,
495 "<= BlackBox::bbSetStatusAndPropagate(input)"
498 //=========================================================================
501 //=========================================================================
502 void BlackBox::bbSignalOutputModification(bool reaction)
504 bbtkBlackBoxDebugMessage("change",5,
505 "=> BlackBox::bbSignalOutputModification("
509 OutputConnectorMapType::iterator i;
510 for ( i = bbGetOutputConnectorMap().begin();
511 i != bbGetOutputConnectorMap().end(); ++i)
513 // std::cout << "Stat = "
514 //<<GetIOStatusString(i->second->GetStatus())
516 // LG : CANNOT SIGNAL ONLY WHEN UPTODATE
517 // See bbtkSampleOutputObserver
518 // if (i->second->GetStatus()==UPTODATE)
520 i->second->SignalChange(GetThisPointer<BlackBox>(),i->first);
524 if (reaction) bbGlobalProcessExecutionList();
526 bbtkBlackBoxDebugMessage("change",5,
527 "<= BlackBox::bbSignalOutputModification()"
530 //=========================================================================
533 //=========================================================================
534 void BlackBox::bbSignalOutputModification(const std::string& output,
537 bbtkBlackBoxDebugMessage("change",5,
538 "=> BlackBox::bbSignalOutputModification("
539 <<output<<","<<reaction<<")"
542 OutputConnectorMapType::iterator i =
543 bbGetOutputConnectorMap().find(output);
546 if ( i == bbGetOutputConnectorMap().end() )
548 bbtkError("BlackBox["<<bbGetFullName()<<"]::bbSignalOutputModification("<<output<<") : unknown output");
551 // if (i->second->GetStatus()==UPTODATE)
553 i->second->SignalChange(GetThisPointer<BlackBox>(),i->first);
554 // Has to notify the output "BoxChange" also
555 if (output != "BoxChange")
557 i = bbGetOutputConnectorMap().find("BoxChange");
558 if ( i != bbGetOutputConnectorMap().end() )
560 i->second->SignalChange(GetThisPointer<BlackBox>(),i->first);
563 if (reaction) bbGlobalProcessExecutionList();
566 bbtkBlackBoxDebugMessage("change",5,
567 "<= BlackBox::bbSignalOutputModification("
571 //=========================================================================
572 //=========================================================================
573 void BlackBox::bbSignalOutputModification(const std::vector<std::string>& output,
576 bbtkBlackBoxDebugMessage("change",5,
577 "=> BlackBox::bbSignalOutputModification(vector of outputs)"
579 OutputConnectorMapType::iterator i;
580 std::vector<std::string>::const_iterator o;
581 bool changed = false;
582 for (o=output.begin();o!=output.end();++o)
584 // the output "BoxChange" must be signaled **AFTER** all others
585 if (*o == "BoxChange") continue;
586 // Look for the connector
587 i = bbGetOutputConnectorMap().find(*o);
588 if ( i == bbGetOutputConnectorMap().end() )
590 bbtkError("BlackBox["<<bbGetFullName()<<"]::bbSignalOutputModification("<<*o<<") : unknown output");
593 // if (i->second->GetStatus()==UPTODATE)
595 i->second->SignalChange(GetThisPointer<BlackBox>(),i->first);
599 // Has to notify the output "BoxChange" also
600 i = bbGetOutputConnectorMap().find("BoxChange");
601 if ( changed && (i != bbGetOutputConnectorMap().end()))
603 // if (i->second->GetStatus()==UPTODATE)
605 i->second->SignalChange(GetThisPointer<BlackBox>(),i->first);
606 if (reaction) bbGlobalProcessExecutionList();
610 bbtkBlackBoxDebugMessage("change",5,
611 "<= BlackBox::bbSignalOutputModification(vector of outputs)"
614 //=========================================================================
622 //=========================================================================
623 /// Main processing method of the box.
624 void BlackBox::bbExecute(bool force)
626 bbtkBlackBoxDebugMessage("process",2,
627 "=> BlackBox::bbExecute("<<(int)force<<")"
630 // If already executing : return
632 if (bbGetExecuting())
634 bbtkBlackBoxDebugMessage("process",2,
635 " -> already executing : abort"<<std::endl);
640 // If execution frozen : return
641 if (bbGlobalGetFreezeExecution())
643 bbtkBlackBoxDebugMessage("process",2,
644 " -> FreezeExecution global flag is 'true' : abort execution"<<std::endl);
649 // If force is true then update is triggered even if the box is UPTODATE
650 // if (force) bbSetModifiedStatus();
652 if ( bbBoxProcessModeIsManual() )
654 bbLetRecursiveExecuteManualMode = true;
658 // Calls the main recursive execution method
659 bbRecursiveExecute(Connection::Pointer());
662 if ( bbBoxProcessModeIsManual() )
664 bbLetRecursiveExecuteManualMode = false;
668 bbtkBlackBoxDebugMessage("process",2,
669 "<= BlackBox::bbExecute()"
672 //=========================================================================
674 //=========================================================================
675 void BlackBox::bbInitializeProcessing()
679 bbtkBlackBoxDebugMessage("process",2,"** Initialize processing"
681 this->bbRecursiveInitializeProcessing();
682 bbmInitialized = true;
685 //=========================================================================
687 //=========================================================================
688 void BlackBox::bbFinalizeProcessing()
692 bbtkBlackBoxDebugMessage("process",2,"** Finalize processing"
694 this->bbRecursiveFinalizeProcessing();
695 bbmInitialized = false;
698 //=========================================================================
701 //=========================================================================
702 void BlackBox::bbRecursiveExecute( Connection::Pointer caller )
704 bbtkBlackBoxDebugMessage("process",3,
705 "=> BlackBox::bbRecursiveExecute("
706 <<(caller?caller->GetFullName():"0")<<")"
709 // If already executing : return
710 if (bbGetExecuting())
712 bbtkBlackBoxDebugMessage("process",3,
713 " -> already executing : abort"<<std::endl);
717 // If not initialized do it
718 bbInitializeProcessing();
720 bbSetExecuting(true);
721 bool wasExecuting = bbGlobalGetSomeBoxExecuting();
722 bbGlobalSetSomeBoxExecuting(true);
724 // Creates the window if the black box has one
725 this->bbCreateWindow();
727 // Updates its inputs
731 // IOStatus s=OUTOFDATE;
732 // IOStatus s=MODIFIED;
735 if ( ( bbBoxProcessModeIsManual()==false ) ||
736 ( (bbBoxProcessModeIsManual()==true) && (bbLetRecursiveExecuteManualMode==true) ) )
738 s = bbUpdateInputs();
741 if ( (s != UPTODATE) || bbBoxProcessModeIsAlways() )
743 // Displays the window (WxBlackbox)
744 // bbShowWindow(caller);
746 // Actual processing (virtual)
747 if ( ( bbBoxProcessModeIsManual()==false ) ||
748 ( (bbBoxProcessModeIsManual()==true)&&(bbLetRecursiveExecuteManualMode==true) )
751 // printf("EED BlackBox::bbRecursiveExecute bbProcess start %s \n", bbGetFullName().c_str() );
753 // printf("EED BlackBox::bbRecursiveExecute bbProcess end %s \n", bbGetFullName().c_str() );
756 //EED ups if ((bbBoxProcessModeIsManual()==true) && (bbLetRecursiveExecuteManualMode==false))
758 //EED ups bbSignalOutputModification(true);
761 // Update the I/O statuses
762 bbComputePostProcessStatus();
764 // Test output status...
765 OutputConnectorMapType::iterator o;
766 for ( o = bbGetOutputConnectorMap().begin();
767 o!= bbGetOutputConnectorMap().end(); ++o)
769 if (o->second->GetStatus() != UPTODATE)
771 bbtkWarning("BlackBox::bbRecursiveExecute: "
772 <<"all inputs are Up-to-date but output '"
773 <<o->first<<"' is Out-of-date ???");
777 bbtkBlackBoxDebugMessage("process",3," -> Up-to-date : nothing to do"
781 // Shows the window if the black box has one
782 this->bbShowWindow();
785 bbtkBlackBoxDebugMessage("process",3,
786 "<= BlackBox::bbRecursiveExecute()"
789 bbSetExecuting(false);
790 bbGlobalSetSomeBoxExecuting(wasExecuting);
794 //=========================================================================
797 //=========================================================================
798 IOStatus BlackBox::bbUpdateInputs()
800 bbtkBlackBoxDebugMessage("process",4,
801 "=> BlackBox::bbUpdateInputs()"
804 IOStatus s = UPTODATE;
806 InputConnectorMapType::iterator i;
807 for ( i = bbGetInputConnectorMap().begin();
808 i!= bbGetInputConnectorMap().end(); ++i)
810 // if (i->first=="WinHide") continue;
811 // If input type is Void : no recurse
812 //if ( bbGetDescriptor()->GetInputDescriptor(i->first)->GetTypeInfo()
815 bbtkBlackBoxDebugMessage("change",2,
817 <<"': status before update = '"
818 <<GetIOStatusString(i->second->GetStatus())
820 i->second->RecursiveExecute();
821 IOStatus t = i->second->GetStatus();
823 bbtkBlackBoxDebugMessage("change",2,
825 <<"': status before process = '"
826 <<GetIOStatusString(i->second->GetStatus())
830 bbtkBlackBoxDebugMessage("process",4,
831 "<= BlackBox::bbUpdateInputs()"
835 //=========================================================================
837 //==================================================================
838 void BlackBox::bbComputePostProcessStatus()
840 bbtkBlackBoxDebugMessage("process",4,
841 "=> BlackBox::bbComputePostProcessStatus()"
844 IOStatus new_output_status = UPTODATE;
845 if (bbBoxProcessModeIsAlways()) new_output_status = OUTOFDATE;
847 // Update the input statuses
848 InputConnectorMapType::iterator i;
849 for ( i = bbGetInputConnectorMap().begin();
850 i!= bbGetInputConnectorMap().end(); ++i)
852 IOStatus t = i->second->GetStatus();
853 if (t == OUTOFDATE) new_output_status = OUTOFDATE;
854 // A previously MODIFIED status turns to UPTODATE
855 if (t==MODIFIED) i->second->SetStatus(UPTODATE);
856 bbtkBlackBoxDebugMessage("change",2,
857 "Input '"<<i->first<<"' : "
858 << GetIOStatusString(t) << " -> "
859 << GetIOStatusString(i->second->GetStatus())
862 bbtkBlackBoxDebugMessage("change",2,
863 "New output status : "
864 << GetIOStatusString(new_output_status)
866 // Update the output statuses
867 OutputConnectorMapType::iterator o;
868 for ( o = bbGetOutputConnectorMap().begin();
869 o!= bbGetOutputConnectorMap().end(); ++o)
872 //EED if ( ( bbBoxProcessModeIsManual()==false ) ||
873 //EED ( (bbBoxProcessModeIsManual()==true) && (bbLetRecursiveExecuteManualMode==true) )
876 o->second->SetStatus(new_output_status);
878 //EED if (( (bbBoxProcessModeIsManual()==true) && (bbLetRecursiveExecuteManualMode==false) ) )
880 //EED o->second->SetStatus(UPTODATE);
882 //EED } // Manual analysis
886 bbtkBlackBoxDebugMessage("process",4,
887 "<= BlackBox::bbComputePostProcessStatus()"
890 //==================================================================
892 //=========================================================================
893 void BlackBox::bbConnectInput( const std::string& name, Connection* c)
895 bbtkBlackBoxDebugMessage("connection",2,
896 "==> BlackBox::bbConnectInput(\""
897 <<name<<"\","<<c->GetFullName()<<")"
900 InputConnectorMapType::iterator i = bbGetInputConnectorMap().find(name);
901 if (i==bbGetInputConnectorMap().end())
903 bbtkError("no input called '"<<name<<"'");
905 i->second->SetConnection(c);
906 // The input *MUST* be set OUTOFDATE to update its input on next execution
907 bbSetStatusAndPropagate(i->second,OUTOFDATE);
909 bbtkBlackBoxDebugMessage("connection",2,
910 "<== BlackBox::bbConnectInput(\""
911 <<name<<"\","<<c->GetFullName()<<")"
914 //=========================================================================
917 //=========================================================================
918 void BlackBox::bbConnectOutput( const std::string& name, Connection* c)
920 bbtkBlackBoxDebugMessage("connection",2,
921 "==> BlackBox::bbConnectOutput(\""<<name<<"\","
922 <<c->GetFullName()<<")"
925 OutputConnectorMapType::iterator i = bbGetOutputConnectorMap().find(name);
926 if (i==bbGetOutputConnectorMap().end())
928 bbtkError("no output called '"<<name<<"'");
930 i->second->SetConnection(c);
932 bbtkBlackBoxDebugMessage("connection",2,
933 "<== BlackBox::bbConnectOutput(\""<<name<<"\","
934 <<c->GetFullName()<<")"
937 //=========================================================================
940 //=========================================================================
941 void BlackBox::bbDisconnectInput( const std::string& name, Connection* c)
944 bbtkBlackBoxDebugMessage("connection",2,
945 "==> BlackBox::bbDisconnectInput(\""<<name
946 <<"\","<<c->GetFullName()<<")"
951 bbtkBlackBoxDebugMessage("connection",2,"c==0"<<std::endl);
955 InputConnectorMapType::iterator i = bbGetInputConnectorMap().find(name);
956 if (i==bbGetInputConnectorMap().end())
958 bbtkError("no input called '"<<name<<"'");
960 i->second->UnsetConnection(c);
962 bbtkBlackBoxDebugMessage("connection",2,
963 "<== BlackBox::bbDisconnectInput(\""<<name
964 <<"\","<<c->GetFullName()<<")"
968 //=========================================================================
971 //=========================================================================
972 void BlackBox::bbDisconnectOutput( const std::string& name, Connection* c)
974 bbtkBlackBoxDebugMessage("connection",2,
975 "==> BlackBox::bbDisconnectOutput(\""<<name
976 <<"\","<<c->GetFullName()<<")"
981 bbtkBlackBoxDebugMessage("connection",2,"c==0"<<std::endl);
985 OutputConnectorMapType::iterator i = bbGetOutputConnectorMap().find(name);
986 if (i==bbGetOutputConnectorMap().end())
988 bbtkError("no output called '"<<name<<"'");
990 i->second->UnsetConnection(c);
992 bbtkBlackBoxDebugMessage("connection",2,
993 "<== BlackBox::bbDisconnectOutput(\""<<name
994 <<"\","<<c->GetFullName()<<")"
997 //=========================================================================
1021 //=========================================================================
1022 void BlackBox::bbWriteDotInputOutputName(FILE *ff,bool inputoutput,int detail, int level)
1024 fprintf(ff,"%s%p",bbGetTypeName().c_str(),this);
1026 //=========================================================================
1029 //=========================================================================
1030 std::string BlackBox::bbGetOutputAsString( const std::string &output )
1033 // Looks for the adaptor
1034 if (bbGetOutputType(output).name() != typeid(std::string).name() )
1037 Package::Pointer p = bbGetDescriptor()->GetPackage();
1038 if ((p != 0) && ( ! p->GetFactorySet().empty() ) )
1040 Factory::Pointer f = p->GetFactorySet().begin()->lock();
1041 BlackBox::Pointer a;
1045 bbGetOutputType(output),
1046 typeid(std::string),
1048 } catch (bbtk::Exception e)
1053 a->bbSetInput("In",bbGetOutput(output));
1055 v = a->bbGetOutput("Out").unsafe_get<std::string>() ;
1057 v="? (no adaptor found)";
1062 v="? (no factory found)";
1068 v = bbGetOutput(output).unsafe_get<std::string>() ;
1072 //=========================================================================
1074 //=========================================================================
1075 std::string BlackBox::bbGetInputAsString( const std::string &input )
1078 // Looks for the adaptor
1079 if (bbGetInputType(input) != typeid(std::string))
1082 Package::Pointer p = bbGetDescriptor()->GetPackage();
1083 if ((p != 0) && ( ! p->GetFactorySet().empty() ) )
1085 Factory::Pointer f = p->GetFactorySet().begin()->lock();
1086 BlackBox::Pointer a;
1090 bbGetInputType(input),
1091 typeid(std::string),
1093 }catch (bbtk::Exception e)
1099 a->bbSetInput("In",bbGetInput(input));
1101 v = a->bbGetOutput("Out").unsafe_get<std::string>() ;
1105 v="? (no adaptor found)";
1110 v="? (no factory found)";
1115 v = bbGetInput(input).unsafe_get<std::string>() ;
1119 //=======================================================================
1121 //=======================================================================
1122 // Replaces substrings "<" by "["
1123 void SubsBrackets ( std::string& s )
1125 // std::cout << "BEFORE=["<<s<<"]"<<std::endl;
1126 std::string ss("<");
1127 std::string::size_type pos = 0;
1129 std::string cr("[");
1130 while ( pos != std::string::npos )
1132 // std::cout << "*** find one "<<std::endl;
1133 s.replace(pos,1,cr.c_str(),1);
1134 pos = s.find(ss, pos);
1140 while ( pos != std::string::npos )
1142 // std::cout << "*** find one "<<std::endl;
1143 s.replace(pos,1,cr.c_str(),1);
1144 pos = s.find(ss, pos);
1150 while ( pos != std::string::npos )
1152 // std::cout << "*** find one "<<std::endl;
1153 s.replace(pos,1,cr.c_str(),1);
1154 pos = s.find(ss, pos);
1155 } // std::cout << "AFTER=["<<s<<"]"<<std::endl;
1157 //=======================================================================
1159 //=========================================================================
1160 /// Write Graphviz-dot description in file
1161 void BlackBox::bbWriteDotFileBlackBox(FILE *ff,
1162 BlackBox::Pointer parentblackbox,
1163 int detail, int level,
1164 bool instanceOrtype,
1165 bool relative_link )
1168 InputConnectorMapType::iterator i;
1170 std::string labelStr;
1171 std::string valueStr("");
1174 labelStr = bbGetName() ;
1176 labelStr = labelStr + "\\n[" +this->bbGetDescriptor()->GetPackage()->GetName()+"::"+ bbGetTypeName() + "]";
1178 labelStr = bbGetName();
1179 labelStr = labelStr + " [" +this->bbGetDescriptor()->GetPackage()->GetName()+"::"+ bbGetTypeName() + "] ";
1182 SubsBrackets(labelStr);
1185 labelStr = labelStr + " | {{ ";
1186 std::string tempStrTypeName;
1189 for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
1193 labelStr=labelStr+" | ";
1196 if (instanceOrtype==true)
1198 valueStr = this->bbGetInputAsString(i->first) + " = ";
1200 const BlackBoxInputDescriptor* id = bbGetDescriptor()->GetInputDescriptor(i->first);
1201 tempStrTypeName=id->GetTypeName();
1202 SubsBrackets(tempStrTypeName);
1203 std::string Name(i->first);
1205 labelStr=labelStr + "<"+i->first.c_str()+"> " + valueStr + Name.c_str() + " [" + tempStrTypeName.c_str() + "]";
1207 labelStr=labelStr+ " } | {";
1209 OutputConnectorMapType::iterator ii;
1210 for ( ii = mOutputConnectorMap.begin(); ii != mOutputConnectorMap.end(); ++ii )
1214 labelStr=labelStr+" | ";
1217 if (instanceOrtype==true)
1219 valueStr = this->bbGetOutputAsString(ii->first) + " = ";
1221 const BlackBoxOutputDescriptor* id = bbGetDescriptor()->GetOutputDescriptor(ii->first);
1222 tempStrTypeName=id->GetTypeName();
1223 SubsBrackets(tempStrTypeName);
1224 std::string Name(ii->first);
1226 labelStr=labelStr+"<"+ii->first.c_str()+"> " + valueStr + Name.c_str() + " ["+tempStrTypeName+"]";
1228 labelStr = labelStr+ " } }" ;
1232 bbWriteDotInputOutputName(ff,true,detail,level);
1233 std::string tmp ( bbGetTypeName() );
1237 url = this->bbGetDescriptor()->GetPackage()->GetDocRelativeURL() + "#" + tmp;
1239 url = this->bbGetDescriptor()->GetPackage()->GetDocURL() + "#" + tmp;
1241 fprintf( ff , " [shape=record, URL=\"%s\",label=\"%s\"]%s\n",url.c_str(),labelStr.c_str(),";" );
1242 // std::cout << labelStr << std::endl;
1245 if (GetThisPointer<BlackBox>()!=parentblackbox){
1246 for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
1250 Connection* con = i->second->GetConnection();
1252 BlackBox::Pointer a=con->GetOriginalBlackBoxFrom();
1253 BlackBox::Pointer b=con->GetOriginalBlackBoxTo();
1255 a->bbWriteDotInputOutputName(ff,false,detail,level);
1258 fprintf(ff,":%s",con->GetOriginalBlackBoxFromOutput().c_str());
1261 b->bbWriteDotInputOutputName(ff,true,detail,level);
1264 fprintf(ff,":%s",con->GetOriginalBlackBoxToInput().c_str());
1266 fprintf(ff,"%s\n",";");
1270 } // if parentblackbox
1272 //=========================================================================
1277 //=========================================================================
1278 void BlackBox::bbPrintHelp(BlackBox::Pointer parentblackbox,
1279 int detail, int level
1280 /*,Factory *factory*/ )
1283 if (this->bbGetDescriptor()->GetPackage())
1285 bbtkBlackBoxMessage("help",1,"Black Box '"<<bbGetName()<<"' <"<<
1286 this->bbGetDescriptor()->GetPackage()->GetName()
1287 <<"::"<<this->bbGetDescriptor()->GetTypeName()<<">"<<std::endl);
1291 bbtkBlackBoxMessage("help",1,"Black Box <::"<<this->bbGetDescriptor()->GetTypeName()<<">"<<std::endl);
1296 bbtkBlackBoxMessage("help",1,"Up-to-date ["<<mMaxInputChangeTime<<","
1297 <<mMinOutputChangeTime<<"]"<<std::endl);
1301 bbtkBlackBoxMessage("help",1,"Out-of-date ["<<mMaxInputChangeTime<<","
1302 <<mMinOutputChangeTime<<"]"<<std::endl);
1305 // bbtkBlackBoxMessage("help",1," "<<GetDescription()<<std::endl);
1306 // bbtkBlackBoxMessage("help",1," By : "<<GetAuthor()<<std::endl);
1308 std::vector<std::string> iname;
1309 std::vector<std::string> ivalue;
1310 std::vector<std::string> iconn;
1311 std::vector<std::string> istatus;
1313 InputConnectorMapType::iterator i;
1314 unsigned int namelmax = 0;
1315 unsigned int valuelmax = 0;
1316 // unsigned int connlmax = 0;
1317 for ( i = mInputConnectorMap.begin(); i != mInputConnectorMap.end(); ++i )
1319 iname.push_back(i->first);
1320 if (iname.back().size()>namelmax) namelmax = iname.back().size();
1321 ivalue.push_back(bbGetInputAsString(i->first));
1322 if (ivalue.back().size()>valuelmax) valuelmax = ivalue.back().size();
1324 Connection* con = i->second->GetConnection();
1326 s = con->GetOriginalBlackBoxFrom()->bbGetName();
1328 s += con->GetOriginalBlackBoxFromOutput();
1331 istatus.push_back(GetIOStatusString(i->second->GetStatus()));
1333 OutputConnectorMapType::iterator o;
1334 std::vector<std::string> oname;
1335 std::vector<std::string> ovalue;
1336 std::vector<std::vector<std::string> > oconn;
1337 std::vector<std::string> ostatus;
1338 for ( o = mOutputConnectorMap.begin(); o != mOutputConnectorMap.end(); ++o )
1340 oname.push_back(o->first);
1341 if (oname.back().size()>namelmax)
1342 namelmax = oname.back().size();
1343 ovalue.push_back(bbGetOutputAsString(o->first));
1344 if (ovalue.back().size()>valuelmax)
1345 valuelmax = ovalue.back().size();
1346 std::vector<std::string> ss;
1347 const std::vector<Connection*>& con
1348 = o->second->GetConnectionVector();
1349 std::vector<Connection*>::const_iterator c;
1350 for (c=con.begin();c!=con.end();++c)
1353 s = (*c)->GetOriginalBlackBoxTo()->bbGetName();
1355 s += (*c)->GetOriginalBlackBoxToInput();
1358 oconn.push_back(ss);
1359 ostatus.push_back(GetIOStatusString(o->second->GetStatus()));
1363 bbtkBlackBoxMessage("help",1," * Inputs : "<<std::endl);
1365 bbtkBlackBoxMessage("help",1," * No inputs"<<std::endl);
1367 std::vector<std::string>::iterator i1,i2,i3,i4;
1368 for (i1=iname.begin(),i2=ivalue.begin(),i3=iconn.begin(),i4=istatus.begin();
1369 i1!=iname.end(),i2!=ivalue.end(),i3!=iconn.end(),i4!=istatus.end();
1370 ++i1,++i2,++i3,++i4)
1372 std::string name(*i1);
1374 name.append(1+namelmax-name.size(),' ');
1375 std::string value(*i2);
1377 value.append(1+valuelmax-value.size(),' ');
1379 bbtkBlackBoxMessage("help",1," '"<<name<<" = '"<<value<<" <-- '" <<*i3<<"'");
1381 bbtkBlackBoxMessage("help",1," '"<<name<<" = '"<<value);
1382 bbtkBlackBoxMessage("help",1," ["<<*i4<<"]"<<std::endl);
1386 bbtkBlackBoxMessage("help",1," * Outputs : "<<std::endl);
1388 bbtkBlackBoxMessage("help",1," * No outputs"<<std::endl);
1390 std::vector<std::vector<std::string> >::iterator i5;
1392 for (i1=oname.begin(),i2=ovalue.begin(),i5=oconn.begin(),i4=ostatus.begin();
1393 i1!=oname.end(),i2!=ovalue.end(),i5!=oconn.end(),i4!=ostatus.end();
1394 ++i1,++i2,++i4,++i5)
1396 std::string name(*i1);
1398 name.append(1+namelmax-name.size(),' ');
1399 std::string value(*i2);
1401 value.append(1+valuelmax-value.size(),' ');
1403 bbtkBlackBoxMessage("help",1," '"<<name<<" = '"<<value);
1406 std::string pref = " '"+name+" = '"+value;
1407 for (i3=i5->begin();i3!=i5->end();++i3)
1409 bbtkBlackBoxMessage("help",1,pref<<" --> '"<<*i3<<"'");
1410 pref.replace(0,pref.size(),pref.size(),' ');
1413 bbtkBlackBoxMessage("help",1," ["<<*i4<<"]"<<std::endl);
1417 //=========================================================================
1436 static bool bbmgGlobalProcessingExecutionList = false;
1438 //=========================================================================
1439 void BlackBox::bbGlobalProcessExecutionList()
1441 bbtkDebugMessage("process",3,
1442 "=> BlackBox::bbGlobalProcessExecutionList()"
1444 if (bbmgGlobalProcessingExecutionList)
1446 bbtkDebugMessage("process",3,"BlackBox::bbGlobalProcessExecutionList() reentered !");
1449 bbmgGlobalProcessingExecutionList = true;
1451 std::set<BlackBox::WeakPointer>::iterator i;
1452 while (bbmgExecutionList.size()>0)
1454 i = bbmgExecutionList.begin();
1455 BlackBox::WeakPointer p = *i;
1456 bbmgExecutionList.erase(i);
1459 bbtkDebugMessage("process",4,
1461 p.lock()->bbGetName()<<"'"<<std::endl);
1462 p.lock()->bbExecute(true);
1466 bbtkGlobalError("Strange error in BlackBox::bbGlobalProcessExecutionList() : Weak bb pointer in bbmgExecutionList is no more valid...");
1470 bbmgExecutionList.clear();
1471 bbtkDebugMessage("process",3,
1472 "<= BlackBox::bbGlobalProcessExecutionList()"
1475 bbmgGlobalProcessingExecutionList = false;
1479 //=========================================================================
1481 bool BlackBox::bbGlobalGetSomeBoxExecuting()
1483 return bbmgSomeBoxExecuting;
1486 void BlackBox::bbGlobalSetSomeBoxExecuting(bool b)
1488 bbmgSomeBoxExecuting = b;
1491 void BlackBox::bbGlobalSetFreezeExecution(bool b)
1493 bbmgFreezeExecution = b;
1496 bool BlackBox::bbGlobalGetFreezeExecution()
1498 return bbmgFreezeExecution;
1501 void BlackBox::bbGlobalAddToExecutionList( BlackBox::Pointer b )
1503 bbtkDebugMessage("process",3,"* bbGlobalAddToExecutionList("<<b->bbGetName()<<")"<<std::endl);
1504 if (bbmgGlobalProcessingExecutionList)
1506 bbtkDebugMessage("process",3,"bbGlobalAddToExecutionList called inside bbGlobalProcessExecutionList !");
1508 bbmgExecutionList.insert(b);
1512 //=========================================================================
1514 //=========================================================================
1515 void BlackBox::Check(bool recursive)
1517 bbtkBlackBoxMessage("debug",1,"*** Checking"
1518 <<" ... OK"<<std::endl);
1520 //=========================================================================
1525 } // EO namespace bbtk