1 /*=========================================================================
4 Module: $RCSfile: bbtkAtomicBlackBox.cxx,v $
6 Date: $Date: 2008/02/07 11:06:37 $
7 Version: $Revision: 1.1 $
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()<<std::endl);
77 bbtkDebugMessage("Process",5,"BoxProcessMode = "<<bbGetInputBoxProcessMode()<<std::endl);
80 if ( bbGetStatus() == UPDATING )
82 bbtkMessage("Warning",1,"!! WARNING !! Cyclic pipeline execution (bbBackwardUpdate ["<<bbGetFullName()<<"] reentered). This may indicate an error in pipeline conception"<<std::endl);
84 bbSetStatus(MODIFIED);
88 if ( ( bbGetStatus() == MODIFIED ) ||
89 ( bbBoxProcessModeIsAlways() ) )
91 bool wasExecuting = bbGlobalGetSomeBoxExecuting();
92 bbGlobalSetSomeBoxExecuting(true);
94 // bbSetStatus(UPDATING);
97 IOStatus s = bbUpdateInputs();
99 bbtkDebugMessage("Process",6,"Inputs post-update status = "<<s<<std::endl);
100 // If all inputs are in UPTODATE post-update status
101 // and mProcessMode is not "Always"
102 // then the box is now UPTODATE
103 if ( ( s == UPTODATE ) &&
104 ( ! bbBoxProcessModeIsAlways() ) )
106 bbSetStatus(UPTODATE);
110 // else it remains MODIFIED
111 bbSetStatus(MODIFIED);
114 // Creates the window (WxBlackbox)
117 // Children update (WxContainerBlackBox)
118 // bbUpdateChildren(caller);
123 // Displays the window (WxBlackbox)
124 bbShowWindow(caller);
128 bbGlobalSetSomeBoxExecuting(wasExecuting);
134 bbtkDebugMessage("Process",5,"Up-to-date : nothing to do"<<std::endl);
137 bbtkDebugMessage("Process",5,"Final Status = "
138 <<bbGetStatus()<<std::endl);
139 bbtkDebugMessage("Process",1,
140 "<= AtomicBlackBox::bbBackwardUpdate() ["
141 <<bbGetFullName()<<"]"<<std::endl);
142 bbtkDebugDecTab("Process",1);
144 return bbGetStatus();
147 //=========================================================================
150 //=========================================================================
151 Data AtomicBlackBox::bbGetOutput( const std::string &name )
153 bbtkDebugMessageInc("Data",7,
154 "AtomicBlackBox::bbGetOutput(\""<<name<<"\") ["
155 <<bbGetFullName()<<"]"
158 Data p = ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()->GetOutputDescriptor(name))->GetGetFunctor()->Get(this);
160 bbtkDebugDecTab("Data",7);
163 //=========================================================================
166 //=========================================================================
167 /// Gets the input Data of a given name
168 Data AtomicBlackBox::bbGetInput( const std::string &name )
170 bbtkDebugMessageInc("Data",7,
171 "AtomicBlackBox::bbGetInput(\""<<name<<"\") ["
172 <<bbGetFullName()<<"]"
175 Data p = ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetGetFunctor()->Get(this);
177 bbtkDebugDecTab("Data",7);
180 //=========================================================================
183 //=========================================================================
184 /// Sets the data of the output called <name>
185 void AtomicBlackBox::bbSetOutput( const std::string &name, Data data)
187 bbtkDebugMessageInc("Data",7,
188 "AtomicBlackBox::bbSetOutput(\""<<name<<"\",data) ["
189 <<bbGetFullName()<<"]"
192 ((AtomicBlackBoxOutputDescriptor*)bbGetDescriptor()->GetOutputDescriptor(name))->GetSetFunctor()->Set(this,data);
194 bbtkDebugDecTab("Data",7);
196 //=========================================================================
199 //=========================================================================
200 /// Sets the data of the input called <name>
201 void AtomicBlackBox::bbSetInput( const std::string &name, Data data,
204 bbtkDebugMessageInc("Data",7,
205 "AtomicBlackBox::bbSetInput(\""<<name<<"\",data) ["
206 <<bbGetFullName()<<"]"
208 ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->Set(this,data);
212 bbSetModifiedStatus();
215 bbtkDebugDecTab("Data",7);
217 //=========================================================================
219 //=========================================================================
220 /// Sets the data of the input called <name>
221 void AtomicBlackBox::bbBruteForceSetInputPointer( const std::string &name,
225 bbtkDebugMessageInc("Data",7,
226 "AtomicBlackBox::bbBruteForceSetInputPointer(\""
228 <<bbGetFullName()<<"]"
230 ((AtomicBlackBoxInputDescriptor*)bbGetDescriptor()->GetInputDescriptor(name))->GetSetFunctor()->BruteForceSetPointer(this,data);
234 bbSetModifiedStatus();
237 bbtkDebugDecTab("Data",7);
239 //=========================================================================