1 /*=========================================================================
4 Module: $RCSfile: bbtkAtomicBlackBox.cxx,v $
6 Date: $Date: 2008/03/20 15:27:56 $
7 Version: $Revision: 1.2 $
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::AtomicBlackBox : abstract user defined black boxes
24 #include "bbtkAtomicBlackBox.h"
29 //=========================================================================
30 AtomicBlackBox::AtomicBlackBox(const std::string &name, bool alloc)
33 bbtkDebugMessageInc("Kernel",7,
34 "AtomicBlackBox::AtomicBlackBox(\""
35 <<name<<"\")"<<std::endl);
36 bbtkDebugDecTab("Kernel",7);
38 //=========================================================================
40 //=========================================================================
41 /// Constructor from an existing box (copy) with a new name
42 AtomicBlackBox::AtomicBlackBox(AtomicBlackBox& from,
43 const std::string &name,
47 bbtkDebugMessageInc("Kernel",7,
48 "AtomicBlackBox::AtomicBlackBox("
49 <<from.bbGetFullName()<<",\""
50 <<name<<"\")"<<std::endl);
51 bbtkDebugDecTab("Kernel",7);
54 //=========================================================================
57 //=========================================================================
59 AtomicBlackBox::~AtomicBlackBox()
61 bbtkDebugMessage("Kernel",7,"AtomicBlackBox::~AtomicBlackBox()"
64 //=========================================================================
68 //=========================================================================
69 /// Main processing method of the box.
70 IOStatus AtomicBlackBox::bbBackwardUpdate( Connection* caller )
72 bbtkDebugMessageInc("Process",1,
73 "=> AtomicBlackBox::bbBackwardUpdate() ["
74 <<bbGetFullName()<<"]"<<std::endl);
76 bbtkDebugMessage("Process",5,"Initial Status = "<<bbGetStatus()
78 bbtkDebugMessage("Process",5,"BoxProcessMode = "
79 <<bbGetInputBoxProcessMode()<<std::endl);
82 if ( bbGetStatus() == UPDATING )
84 bbtkMessage("Warning",1,"!! WARNING !! Cyclic pipeline execution (bbBackwardUpdate ["<<bbGetFullName()<<"] reentered). This may indicate an error in pipeline conception"<<std::endl);
86 bbSetStatus(MODIFIED);
90 if ( ( bbGetStatus() == MODIFIED ) ||
91 ( bbBoxProcessModeIsAlways() ) )
93 bool wasExecuting = bbGlobalGetSomeBoxExecuting();
94 bbGlobalSetSomeBoxExecuting(true);
96 // bbSetStatus(UPDATING);
99 IOStatus s = bbUpdateInputs();
101 bbtkDebugMessage("Process",6,"Inputs post-update status = "<<s<<std::endl);
102 // If all inputs are in UPTODATE post-update status
103 // and mProcessMode is not "Always"
104 // then the box is now UPTODATE
105 if ( ( s == UPTODATE ) &&
106 ( ! bbBoxProcessModeIsAlways() ) )
108 bbSetStatus(UPTODATE);
112 // else it remains MODIFIED
113 bbSetStatus(MODIFIED);
119 // Displays the window (WxBlackbox)
120 bbShowWindow(caller);
122 bbGlobalSetSomeBoxExecuting(wasExecuting);
127 bbtkDebugMessage("Process",5,"Up-to-date : nothing to do"<<std::endl);
130 bbtkDebugMessage("Process",5,"Final Status = "
131 <<bbGetStatus()<<std::endl);
132 bbtkDebugMessage("Process",1,
133 "<= AtomicBlackBox::bbBackwardUpdate() ["
134 <<bbGetFullName()<<"]"<<std::endl);
135 bbtkDebugDecTab("Process",1);
137 return bbGetStatus();
140 //=========================================================================
143 //=========================================================================
144 Data AtomicBlackBox::bbGetOutput( const std::string &name )
146 bbtkDebugMessageInc("Data",7,
147 "AtomicBlackBox::bbGetOutput(\""<<name<<"\") ["
148 <<bbGetFullName()<<"]"
151 Data p = ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()
152 ->GetOutputDescriptor(name))->GetGetFunctor()->Get(this);
154 bbtkDebugDecTab("Data",7);
157 //=========================================================================
160 //=========================================================================
161 /// Gets the input Data of a given name
162 Data AtomicBlackBox::bbGetInput( const std::string &name )
164 bbtkDebugMessageInc("Data",7,
165 "AtomicBlackBox::bbGetInput(\""<<name<<"\") ["
166 <<bbGetFullName()<<"]"
169 Data p = ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()
170 ->GetInputDescriptor(name))->GetGetFunctor()->Get(this);
172 bbtkDebugDecTab("Data",7);
175 //=========================================================================
178 //=========================================================================
179 /// Sets the data of the output called <name>
180 void AtomicBlackBox::bbSetOutput( const std::string &name, Data data)
182 bbtkDebugMessageInc("Data",7,
183 "AtomicBlackBox::bbSetOutput(\""<<name<<"\",data) ["
184 <<bbGetFullName()<<"]"
187 ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()
188 ->GetOutputDescriptor(name))->GetSetFunctor()->Set(this,data);
190 bbtkDebugDecTab("Data",7);
192 //=========================================================================
195 //=========================================================================
196 /// Sets the data of the input called <name>
197 void AtomicBlackBox::bbSetInput(
198 const std::string &name,
202 bbtkDebugMessageInc("Data",7,
203 "AtomicBlackBox::bbSetInput(\""<<name<<"\",data) ["
204 <<bbGetFullName()<<"]"
206 ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->Set(this,data);
210 bbSetModifiedStatus();
213 bbtkDebugDecTab("Data",7);
215 //=========================================================================
217 //=========================================================================
218 /// Sets the data of the input called <name>
219 void AtomicBlackBox::bbBruteForceSetInputPointer
221 const std::string &name,
226 bbtkDebugMessageInc("Data",7,
227 "AtomicBlackBox::bbBruteForceSetInputPointer(\""
229 <<bbGetFullName()<<"]"
231 ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()
232 ->GetInputDescriptor(name))->GetSetFunctor()
233 ->BruteForceSetPointer(this,data);
237 bbSetModifiedStatus();
240 bbtkDebugDecTab("Data",7);
242 //=========================================================================