1 /*=========================================================================
4 Module: $RCSfile: bbtkConnection.cxx,v $
6 Date: $Date: 2008/04/23 14:49:27 $
7 Version: $Revision: 1.11 $
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 =========================================================================*/
20 *\brief Class bbtk::Connection
23 #include "bbtkConnection.h"
24 #include "bbtkFactory.h"
25 #include "bbtkBlackBox.h"
26 #include "bbtkMessageManager.h"
30 Connection::Pointer Connection::New(BlackBox::Pointer from,
31 const std::string& output,
33 const std::string& input ,
34 const Factory::Pointer f )
36 bbtkDebugMessage("object",1,"##> Connection::Connection(\""
37 <<from->bbGetName()<<"\",\""<<output<<"\",\""
38 <<to->bbGetName()<<"\",\""<<input<<"\")"
40 Connection::Pointer p =
41 MakePointer(new Connection(from,output,to,input,f));
42 bbtkDebugMessage("object",1,"<## Connection::Connection(\""
43 <<from->bbGetName()<<"\",\""<<output<<"\",\""
44 <<to->bbGetName()<<"\",\""<<input<<"\")"
49 //==================================================================
50 /// Ctor with the black box from and to and their input and output.
51 /// Check the input and output compatibility
52 Connection::Connection(BlackBox::Pointer from, const std::string& output,
53 BlackBox::Pointer to, const std::string& input ,
54 const Factory::Pointer f )
60 bbtkDebugMessage("object",2,"==> Connection::Connection(\""
61 <<from->bbGetName()<<"\",\""<<output<<"\",\""
62 <<to->bbGetName()<<"\",\""<<input<<"\")"
65 bbtkDebugMessage("connection",1,"==> Connection::Connection(\""
66 <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
67 <<to->bbGetFullName()<<"\",\""<<input<<"\")"
72 if (! from->bbHasOutput(output) )
74 bbtkError("The box \""<<from->bbGetTypeName()<<
75 "\" has no output \""<<output<<"\"");
77 if (! to->bbHasInput(input) )
79 bbtkError("The box \""<<to->bbGetTypeName()<<
80 "\" has no input \""<<input<<"\"");
83 if (to->bbGetInputConnectorMap().find(input)->second->IsConnected())
85 bbtkError("The input \""<<input<<"\" of the box \""<<to->bbGetName()
86 <<"\" is already connected");
89 // std::string t1 ( from->bbGetOutputType(output).name() );
90 // std::string t2 ( to->bbGetInputType(input).name() );
92 if ( from->bbGetOutputType(output) !=
93 to->bbGetInputType(input) )
95 if ( from->bbGetOutputType(output) == typeid(Data) )
97 bbtkWarning("Connection '"
99 <<"' : '"<<from->bbGetName()<<"."<<output
101 <<HumanTypeName<Data>()
102 <<"> : type compatibility with '"
103 <<to->bbGetName()<<"."<<input
104 <<"' will be resolved at run time"
108 else if ( to->bbGetInputType(input) == typeid(Data) )
110 bbtkDebugMessage("Kernel",8," -> '"<<input<<"' type is "
111 <<TypeName<Data>()<<" : can receive any data"
117 // std::cout << "Adaptive connection "<<std::endl;
119 name = from->bbGetName() + "." + output + "-"
120 + to->bbGetName() + "." + input;
121 mAdaptor = mFactory.lock()
122 ->NewAdaptor(from->bbGetOutputType(output),
123 to->bbGetInputType(input),
127 bbtkError("did not find any <"
128 <<TypeName(from->bbGetOutputType(output))
130 <<TypeName(to->bbGetInputType(input))
138 mOriginalFrom = from;
141 mInput = mOriginalInput = input;
142 mOutput = mOriginalOutput = output;
144 // Lock this pointer !!!
145 //Pointer p = MakePointer(this,true);
146 from->bbConnectOutput(output,this);
147 to->bbConnectInput(input,this);
150 bbtkDebugMessage("connection",1,"<== Connection::Connection(\""
151 <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
152 <<to->bbGetFullName()<<"\",\""<<input<<"\")"
155 bbtkDebugMessage("object",2,"==> Connection::Connection(\""
156 <<from->bbGetName()<<"\",\""<<output<<"\",\""
157 <<to->bbGetName()<<"\",\""<<input<<"\")"
160 //==================================================================
162 //==================================================================
164 Connection::~Connection()
166 bbtkDebugMessage("object",2,
167 "==> Connection::~Connection() ["
168 <<GetFullName()<<"]"<<std::endl);
170 if (mAdaptor) mAdaptor.reset();
173 mFrom->bbDisconnectOutput(mOutput,this);
174 // GetThisPointer<Connection>());
179 bbtkInternalError("Connection::~Connection() : invalid initial box pointer");
183 mTo->bbDisconnectInput(mInput,this);// GetThisPointer<Connection>());
188 bbtkInternalError("Connection::~Connection() : invalid final box pointer");
192 bbtkDebugMessage("object",2,
193 "<== Connection::~Connection() ["
194 <<GetFullName()<<"]"<<std::endl);
196 //==================================================================
198 //==================================================================
200 IOStatus Connection::BackwardUpdate()
202 bbtkDebugMessageInc("Process",2,
203 "Connection::BackwardUpdate() ["
204 <<GetFullName()<<"]"<<std::endl);
206 IOStatus s = UPTODATE;
207 s = mFrom->bbBackwardUpdate(GetThisPointer<Connection>());
211 if (mAdaptor && (s==MODIFIED)) mAdaptor->bbSetModifiedStatus();
213 bbtkDebugDecTab("Process",2);
217 //==================================================================
220 //==================================================================
222 void Connection::ForwardUpdate()
224 bbtkDebugMessageInc("Process",2,
225 "Connection::ForwardUpdate() ["
226 <<GetFullName()<<"]"<<std::endl);
231 mTo->bbForwardUpdate(this);
233 bbtkDebugDecTab("Process",2);
235 //==================================================================
238 //==================================================================
239 /// Transfers the data from the source output to the target input
240 /// doing necessary conversions (adaptation or pointer cast)
241 void Connection::TransferData()
243 bbtkDebugMessageInc("Process",3,
244 "Connection::TransferData() ["
245 <<GetFullName()<<"]"<<std::endl);
248 // If an adaptor was created we need to adapt the data
251 mAdaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
252 mAdaptor->bbExecute();
253 // LG : Connection Update does not set mTo as modified
254 mTo->bbSetInput(mInput, mAdaptor->bbGetOutput("Out"),false);
257 // If no adaptor but source type is an any and target is not an any
258 else if ( mFromAny && (! mToAny) )
260 bbtkDebugMessage("Data",3,
261 "Connection::TransferData() ["
262 <<GetFullName()<<"]"<<std::endl);
263 bbtkDebugMessage("Data",3,
264 " * Source type is an "
265 <<HumanTypeName<Data>()
266 <<" which contains a <"
267 <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
269 bbtkDebugMessage("Data",3,
270 " * Target type is <"
271 <<HumanTypeName(mTo->bbGetInputType(mInput))
274 // 1) Test strict type matching between any content and target
275 if (mFrom->bbGetOutput(mOutput)
276 .contains( mTo->bbGetInputType(mInput) ) )
278 bbtkDebugMessage("Data",3,
279 " -> Equal types : transfer ok"<<std::endl);
280 mTo->bbSetInput( mInput,
281 mFrom->bbGetOutput(mOutput),
286 // 2) Look for an adaptor
287 bbtk::BlackBox::Pointer adaptor;
290 adaptor = mFactory.lock()
291 ->NewAdaptor(mFrom->bbGetOutput(mOutput).type(),
292 mTo->bbGetInputType(mInput),
300 bbtkDebugMessage("Data",3," -> Adaptor found : using it"
302 adaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
303 adaptor->bbExecute();
304 // LG : Connection Update does not set mTo as modified
305 mTo->bbSetInput(mInput, adaptor->bbGetOutput("Out"),false);
306 // adaptor->bbDelete();
308 // 3) If no adaptor found but the any content is a pointer
309 // and target type is also a pointer : we try run-time cast
310 else if ( (mFrom->bbGetOutput(mOutput).contains_pointer()) &&
311 (mTo->bbGetDescriptor()->GetInputDescriptor(mInput)
314 bbtkDebugMessage("Data",3,
315 " -> No adaptor found but source and target types are both pointers : trying up or down cast"<<std::endl);
318 mFrom->bbGetOutput(mOutput)
319 .get_pointer_to(mTo->bbGetInput(mInput).pointed_type());
322 bbtkError("Connection '"
325 <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
327 <<HumanTypeName(mTo->bbGetInputType(mInput))
328 <<"> : no adaptor available and run-time up and down cast failed");
330 mTo->bbBruteForceSetInputPointer(mInput, nptr, false);
332 // 4) Nothing worked : error
335 bbtkError("Connection '"<<GetFullName()<<"' "
336 <<"no adaptor found to convert <"
337 <<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
339 <<HumanTypeName(mTo->bbGetInputType(mInput))<<">");
343 // EO : mFromAny && ! mToAny
344 // Default case : types are the same; we use simple get-set
347 // LG : Connection Update does not set mTo as modified
348 mTo->bbSetInput(mInput, mFrom->bbGetOutput(mOutput),false);
351 bbtkDebugDecTab("Process",3);
353 //==================================================================
355 //==================================================================
357 void Connection::SetModifiedStatus()
359 bbtkDebugMessage("modified",2,
360 "==> Connection::SetModifiedStatus() ["
361 <<GetFullName()<<"]"<<std::endl);
363 if (mAdaptor) mAdaptor->bbSetModifiedStatus();
365 mTo->bbSetModifiedStatus( mTo->bbGetInputConnectorMap().find(mInput)->second );
368 bbtkDebugMessage("modified",2,
369 "==> Connection::SetModifiedStatus() ["
370 <<GetFullName()<<"]"<<std::endl);
373 //==================================================================
376 //==================================================================
377 std::string Connection::GetFullName() const {
380 std::string res = mFrom->bbGetName()+"."+mOutput+"--"
381 +mTo->bbGetName()+"."+mInput;
382 if ((!mOriginalFrom.expired()) && (!mOriginalTo.expired()) &&
383 ((mFrom!=mOriginalFrom.lock())||(mTo!=mOriginalTo.lock())))
385 res += "("+mOriginalFrom.lock()->bbGetName()
386 +"."+mOriginalOutput+"--"
387 + mOriginalTo.lock()->bbGetName()+"."+mOriginalInput+")";
391 return "***Invalid Connection***";
393 //==================================================================
395 //==================================================================
396 void Connection::Check() const
398 bbtkMessage("debug",1,"** Checking Connection "<<(void*)this<<" ["<<GetFullName()<<"]"
402 bbtkMessage("debug",2," - From = 0"<<std::endl);
406 bbtkMessage("debug",2," - From : "<<mFrom->bbGetFullName()<<std::endl);
407 if (!mFrom->bbHasOutput(mOutput))
409 bbtkError("** Checking Connection "<<(void*)this
410 <<" ["<<GetFullName()<<"] : "
411 << mFrom->bbGetFullName()<<" does not have output '"
414 bbtkMessage("debug",2," - From : Output '"<<mOutput<<"' exists"<<std::endl);
415 BlackBox::OutputConnectorMapType::const_iterator i
416 = mFrom->bbGetOutputConnectorMap().find(mOutput);
417 if (i== mFrom->bbGetOutputConnectorMap().end())
419 bbtkError("** Checking Connection "<<(void*)this
420 <<" ["<<GetFullName()<<"] : "
421 <<mFrom->bbGetFullName()<<" output '"
422 <<mOutput<<"' is not in OutputConnectorMap");
424 bbtkMessage("debug",2," - From : Output '"<<mOutput
425 <<"' is in OutputConnectorMap"<<std::endl);
427 std::vector< Connection* >::const_iterator j;
429 for (j = i->second->GetConnectionVector().begin();
430 j != i->second->GetConnectionVector().end();
433 if ((*j)==this) break;
436 j = find(i->second->GetConnectionVector().begin(),
437 i->second->GetConnectionVector().end(),
440 if (j==i->second->GetConnectionVector().end())
442 bbtkError("** Checking Connection "<<(void*)this
443 <<" ["<<GetFullName()<<"] : "
444 << "Connection ["<<GetFullName()<<"] : "
445 <<" OutputConnector '"
446 <<mOutput<<"' of "<<mFrom->bbGetFullName()
447 <<" does not point to this connection");
450 bbtkMessage("debug",2," - From : This connection is in OutputConnector connection vector"<<std::endl);
451 bbtkMessage("debug",1," * Box from : Check successfull"<<std::endl);
457 bbtkMessage("debug",2," - To = 0"<<std::endl);
461 bbtkMessage("debug",2," - To : "<<mTo->bbGetName()<<std::endl);
462 // std::cout << mTo << std::endl;
463 // std::cout << mTo->bbGetDescriptor() << std::endl;
464 // std::cout << mTo->bbGetDescriptor()->GetTypeName() << std::endl;
465 // mTo->bbGetFullName();
466 bbtkMessage("debug",2," - To : "<<mTo->bbGetFullName()<<std::endl);
467 if (!mTo->bbHasInput(mInput))
469 bbtkError("** Checking Connection "<<(void*)this
470 <<" ["<<GetFullName()<<"] : "
471 <<mTo->bbGetFullName()<<" does not have input '"
474 bbtkMessage("debug",2," - To : Input '"<<mInput<<"' exists"<<std::endl);
475 BlackBox::InputConnectorMapType::const_iterator i
476 = mTo->bbGetInputConnectorMap().find(mInput);
477 if (i== mTo->bbGetInputConnectorMap().end())
479 bbtkError("** Checking Connection "<<(void*)this
480 <<" ["<<GetFullName()<<"] : "
481 <<mTo->bbGetFullName()<<" input '"
482 <<mInput<<"' is not in InputConnectorMap");
484 bbtkMessage("debug",2," - To : Input '"<<mInput
485 <<"' is in InputConnectorMap"<<std::endl);
487 if (i->second->GetConnection()==0)
489 bbtkError("** Checking Connection "<<(void*)this
490 <<" ["<<GetFullName()<<"] : "
491 <<"Connection "<<GetFullName()<<" : "
492 <<" InputConnector '"
493 <<mInput<<"' of "<<mTo->bbGetFullName()
494 <<" does not point to this connection");
497 bbtkMessage("debug",2," - To : This connection is in InputConnector connection vector"<<std::endl);
498 bbtkMessage("debug",1," * Box to : Check successfull"<<std::endl);
502 //==================================================================
503 //==========================================================================
504 std::string Connection::GetObjectName() const
506 std::string s("Connection '");
511 //==========================================================================
513 //==========================================================================
514 std::string Connection::GetObjectInfo() const
519 //==========================================================================
521 //==========================================================================
522 size_t Connection::GetObjectSize() const
524 size_t s = Superclass::GetObjectSize();
525 s += Connection::GetObjectInternalSize();
528 //==========================================================================
529 //==========================================================================
530 size_t Connection::GetObjectInternalSize() const
532 size_t s = sizeof(Connection);
535 //==========================================================================
536 //==========================================================================
537 size_t Connection::GetObjectRecursiveSize() const
539 size_t s = Superclass::GetObjectRecursiveSize();
540 s += Connection::GetObjectInternalSize();
543 //==========================================================================