+/*
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ # pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ # This software is governed by the CeCILL-B license under French law and
+ # abiding by the rules of distribution of free software. You can use,
+ # modify and/ or redistribute the software under the terms of the CeCILL-B
+ # license as circulated by CEA, CNRS and INRIA at the following URL
+ # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ # or in the file LICENSE.txt.
+ #
+ # As a counterpart to the access to the source code and rights to copy,
+ # modify and redistribute granted by the license, users are provided only
+ # with a limited warranty and the software's author, the holder of the
+ # economic rights, and the successive licensors have only limited
+ # liability.
+ #
+ # The fact that you are presently reading this means that you have had
+ # knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
+
+
/*=========================================================================
-
Program: bbtk
Module: $RCSfile: bbtkConnection.cxx,v $
Language: C++
- Date: $Date: 2008/04/22 06:59:31 $
- Version: $Revision: 1.8 $
-
- Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
- l'Image). All rights reserved. See doc/license.txt or
- http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-
- This software is distributed WITHOUT ANY WARRANTY; without even
- the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
- PURPOSE. See the above copyright notices for more information.
-
+ Date: $Date: 2012/11/16 08:49:01 $
+ Version: $Revision: 1.22 $
=========================================================================*/
+
+
+
/**
*\file
*\brief Class bbtk::Connection
#include "bbtkFactory.h"
#include "bbtkBlackBox.h"
#include "bbtkMessageManager.h"
+#include "bbtkBlackBoxOutputConnector.h"
+
+#define bbtkCMessage(key,level,mess) \
+ bbtkMessage(key,level,"["<<GetFullName()<<"] "<<mess)
+#define bbtkCDebugMessage(key,level,mess) \
+ bbtkDebugMessage(key,level,"["<<GetFullName()<<"] "<<mess)
namespace bbtk
{
+ const std::string IOSTATUS_STRING[3] =
+ {"Up-to-date","Modified","Out-of-date"};
+
+ const std::string& GetIOStatusString(IOStatus s)
+ { return IOSTATUS_STRING[s]; }
+
+ //==================================================================
Connection::Pointer Connection::New(BlackBox::Pointer from,
const std::string& output,
BlackBox::Pointer to,
const std::string& input ,
const Factory::Pointer f )
{
- bbtkDebugMessage("object",1,"##> Connection::Connection(\""
+ bbtkDebugMessage("object",1,"##> Connection(\""
<<from->bbGetName()<<"\",\""<<output<<"\",\""
<<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
Connection::Pointer p =
MakePointer(new Connection(from,output,to,input,f));
- bbtkDebugMessage("object",1,"<## Connection::Connection(\""
+ bbtkDebugMessage("object",1,"<## Connection(\""
<<from->bbGetName()<<"\",\""<<output<<"\",\""
<<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
return p;
}
+ //==================================================================
//==================================================================
/// Ctor with the black box from and to and their input and output.
mFromAny(false),
mToAny(false)
{
- bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+ bbtkDebugMessage("object",2,"==> Connection(\""
<<from->bbGetName()<<"\",\""<<output<<"\",\""
<<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
- bbtkDebugMessage("connection",1,"==> Connection::Connection(\""
- <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
- <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+ bbtkDebugMessage("connection",1,"==> Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
{
if ( from->bbGetOutputType(output) == typeid(Data) )
{
- bbtkWarning("Connection '"
- <<GetFullName()
- <<"' : '"<<from->bbGetName()<<"."<<output
+ bbtkWarning("Connection: '"<<from->bbGetName()<<"."<<output
<<"' is of type <"
<<HumanTypeName<Data>()
<<"> : type compatibility with '"
}
else if ( to->bbGetInputType(input) == typeid(Data) )
{
- bbtkDebugMessage("Kernel",8," -> '"<<input<<"' type is "
+ bbtkDebugMessage("kernel",8," -> '"<<input<<"' type is "
<<TypeName<Data>()<<" : can receive any data"
<<std::endl);
mToAny = true;
}
+ mFrom = from;
+ mOriginalFrom = from;
+ mTo = to;
+ mOriginalTo = to;
+ mInput = mOriginalInput = input;
+ mOutput = mOriginalOutput = output;
+
+ // Lock this pointer !!!
+ //Pointer p = MakePointer(this,true);
+ from->bbConnectOutput(output,this);
+ to->bbConnectInput(input,this);
+
+ from->bbGetOutputConnector(output).AddChangeObserver(boost::bind(&bbtk::Connection::OnOutputChange,this, _1, _2, _3));
+
+
+ bbtkDebugMessage("connection",1,"<== Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+
+ bbtkDebugMessage("object",2,"<== Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+ }
+ //==================================================================
+
+ //==================================================================
+ Connection::Pointer Connection::New(BlackBox::Pointer from,
+ const std::string& output,
+ BlackBox::Pointer to,
+ const std::string& input )
+ {
+ bbtkDebugMessage("object",1,"##> Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+ Connection::Pointer p =
+ MakePointer(new Connection(from,output,to,input));
+ bbtkDebugMessage("object",1,"<## Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+ return p;
+ }
+ //==================================================================
+
+ //==================================================================
+ /// Ctor with the black box from and to and their input and output.
+/// Check the input and output compatibility
+Connection::Connection(BlackBox::Pointer from, const std::string& output,
+ BlackBox::Pointer to, const std::string& input )
+ : mAdaptor(),
+ mFactory(),
+ mFromAny(false),
+ mToAny(false)
+ {
+ bbtkDebugMessage("object",2,"==> Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+
+ bbtkDebugMessage("connection",1,"==> Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
+ <<std::endl);
+
+
+
+ if (! from->bbHasOutput(output) )
+ {
+ bbtkError("The box \""<<from->bbGetTypeName()<<
+ "\" has no output \""<<output<<"\"");
+ }
+ if (! to->bbHasInput(input) )
+ {
+ bbtkError("The box \""<<to->bbGetTypeName()<<
+ "\" has no input \""<<input<<"\"");
+ }
+
+ if (to->bbGetInputConnectorMap().find(input)->second->IsConnected())
+ {
+ bbtkError("The input \""<<input<<"\" of the box \""<<to->bbGetName()
+ <<"\" is already connected");
+ }
+
+ // std::string t1 ( from->bbGetOutputType(output).name() );
+ // std::string t2 ( to->bbGetInputType(input).name() );
+ // if //( t1 != t2 )
+ if ( from->bbGetOutputType(output) !=
+ to->bbGetInputType(input) )
+ {
+ if ( from->bbGetOutputType(output) == typeid(Data) )
+ {
+ bbtkWarning("Connection '"
+ <<GetFullName()
+ <<"' : '"<<from->bbGetName()<<"."<<output
+ <<"' is of type <"
+ <<HumanTypeName<Data>()
+ <<"> : type compatibility with '"
+ <<to->bbGetName()<<"."<<input
+ <<"' will be resolved at run time"
+ );
+ mFromAny = true;
+ }
+ else if ( to->bbGetInputType(input) == typeid(Data) )
+ {
+ bbtkDebugMessage("kernel",8," -> '"<<input<<"' type is "
+ <<TypeName<Data>()<<" : can receive any data"
+ <<std::endl);
+ mToAny = true;
+ }
+ else
+ {
+ bbtkError("Connection created between different types without Factory provided");
+ }
+ }
+
+
mFrom = from;
mOriginalFrom = from;
mTo = to;
mOutput = mOriginalOutput = output;
// Lock this pointer !!!
- Pointer p = MakePointer(this,true);
- from->bbConnectOutput(output,p);
- to->bbConnectInput(input,p);
+ //Pointer p = MakePointer(this,true);
+ from->bbConnectOutput(output,this);
+ to->bbConnectInput(input,this);
+ from->bbGetOutputConnector(output).AddChangeObserver(boost::bind(&bbtk::Connection::OnOutputChange,this, _1, _2, _3));
- bbtkDebugMessage("connection",1,"<== Connection::Connection(\""
- <<from->bbGetFullName()<<"\",\""<<output<<"\",\""
- <<to->bbGetFullName()<<"\",\""<<input<<"\")"
+ bbtkDebugMessage("connection",1,"<== Connection(\""
+ <<from->bbGetName()<<"\",\""<<output<<"\",\""
+ <<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
- bbtkDebugMessage("object",2,"==> Connection::Connection(\""
+ bbtkDebugMessage("object",2,"==> Connection(\""
<<from->bbGetName()<<"\",\""<<output<<"\",\""
<<to->bbGetName()<<"\",\""<<input<<"\")"
<<std::endl);
/// Dtor
Connection::~Connection()
{
- bbtkDebugMessage("object",2,
- "==> Connection::~Connection() ["
- <<GetFullName()<<"]"<<std::endl);
+ bbtkCDebugMessage("object",4,
+ "==> ~Connection()"
+ <<std::endl);
if (mAdaptor) mAdaptor.reset();
- mOriginalFrom.reset();
- mOriginalTo.reset();
if (mFrom!=0)
{
- mFrom->bbDisconnectOutput(mOutput,
- GetThisPointer<Connection>());
+ mFrom->bbDisconnectOutput(mOutput,this);
+ // GetThisPointer<Connection>());
+ mFrom.reset();
}
else
{
- bbtkInternalError("Connection::~Connection() : invalid initial box pointer");
+ bbtkInternalError("~Connection() : invalid initial box pointer");
}
if (mTo!=0)
{
- mTo->bbDisconnectInput(mInput,
- GetThisPointer<Connection>());
+ mTo->bbDisconnectInput(mInput,this);// GetThisPointer<Connection>());
+ mTo.reset();
}
else
{
- bbtkInternalError("Connection::~Connection() : invalid final box pointer");
+ bbtkInternalError("~Connection() : invalid final box pointer");
}
- mFrom.reset();
- mTo.reset();
- bbtkDebugMessage("object",2,
- "<== Connection::~Connection() ["
- <<GetFullName()<<"]"<<std::endl);
+
+ bbtkCDebugMessage("object",4,
+ "<== ~Connection()"
+ <<std::endl);
}
//==================================================================
//==================================================================
- /// Backward Update
- IOStatus Connection::BackwardUpdate()
+ /// Recursive execution
+ void Connection::RecursiveExecute()
{
- bbtkDebugMessageInc("Process",2,
- "Connection::BackwardUpdate() ["
- <<GetFullName()<<"]"<<std::endl);
+ bbtkCDebugMessage("process",4,
+ "===> Connection::RecursiveExecute()"
+ <<std::endl);
- IOStatus s = UPTODATE;
- s = mFrom->bbBackwardUpdate(GetThisPointer<Connection>());
+ /*
+ // If box from already executing : nothing to do
+ if (mFrom->bbGetExecuting())
+ {
+ bbtkDebugMessage("process",3,
+ " -> "<<mFrom->bbGetName()
+ <<" already executing : abort"<<std::endl);
+ return;
- TransferData();
+ }
+ */
- if (mAdaptor && (s==MODIFIED)) mAdaptor->bbSetModifiedStatus();
+ mFrom->bbRecursiveExecute(GetThisPointer<Connection>());
- bbtkDebugDecTab("Process",2);
+ TransferData();
- return s;
+ // Transfer status
+ IOStatus s = MODIFIED;
+ if ( mFrom->bbGetOutputConnector(mOutput).GetStatus() == OUTOFDATE)
+ {
+ s = OUTOFDATE;
+ }
+ mTo->bbGetInputConnector(mInput).SetStatus(s);
+
+ bbtkCDebugMessage("process",4,
+ " --> '"<<mTo->bbGetName()<<"."<<mInput
+ <<" ["<<&mTo->bbGetInputConnector(mInput)<<"] "
+ <<"' new status '"
+ <<GetIOStatusString(s)
+ <<"'"
+ << std::endl);
+
+ bbtkCDebugMessage("process",4,
+ "<=== Connection::RecursiveExecute()"
+ <<std::endl);
+ return;
}
//==================================================================
- /*
- //==================================================================
- /// Forward Update
- void Connection::ForwardUpdate()
- {
- bbtkDebugMessageInc("Process",2,
- "Connection::ForwardUpdate() ["
- <<GetFullName()<<"]"<<std::endl);
-
-
- TransferData();
-
- mTo->bbForwardUpdate(this);
- bbtkDebugDecTab("Process",2);
- }
- //==================================================================
- */
//==================================================================
/// Transfers the data from the source output to the target input
/// doing necessary conversions (adaptation or pointer cast)
void Connection::TransferData()
{
- bbtkDebugMessageInc("Process",3,
- "Connection::TransferData() ["
- <<GetFullName()<<"]"<<std::endl);
+ bbtkCDebugMessage("data",3,
+ "Connection::TransferData()"
+ <<std::endl);
// If an adaptor was created we need to adapt the data
// If no adaptor but source type is an any and target is not an any
else if ( mFromAny && (! mToAny) )
{
- bbtkDebugMessage("Data",3,
- "Connection::TransferData() ["
- <<GetFullName()<<"]"<<std::endl);
- bbtkDebugMessage("Data",3,
+ bbtkCDebugMessage("data",3,
" * Source type is an "
<<HumanTypeName<Data>()
<<" which contains a <"
<<HumanTypeName(mFrom->bbGetOutput(mOutput).type())
<<">"<<std::endl);
- bbtkDebugMessage("Data",3,
+ bbtkCDebugMessage("data",3,
" * Target type is <"
<<HumanTypeName(mTo->bbGetInputType(mInput))
<<">"<<std::endl);
+ // 0) If from any contents void : nothing to do
+ if (mFrom->bbGetOutput(mOutput).type() == typeid(void))
+ {
+ bbtkCDebugMessage("data",3,
+ " -> Source is void : nothing to transfer!"<<std::endl);
+ }
// 1) Test strict type matching between any content and target
- if (mFrom->bbGetOutput(mOutput)
+ else if (mFrom->bbGetOutput(mOutput)
.contains( mTo->bbGetInputType(mInput) ) )
{
- bbtkDebugMessage("Data",3,
+ bbtkCDebugMessage("data",3,
" -> Equal types : transfer ok"<<std::endl);
mTo->bbSetInput( mInput,
mFrom->bbGetOutput(mOutput),
}
if (adaptor)
{
- bbtkDebugMessage("Data",3," -> Adaptor found : using it"
+ bbtkCDebugMessage("data",3," -> Adaptor found : using it"
<<std::endl);
adaptor->bbSetInput("In",mFrom->bbGetOutput(mOutput),false);
adaptor->bbExecute();
(mTo->bbGetDescriptor()->GetInputDescriptor(mInput)
->IsPointerType()) )
{
- bbtkDebugMessage("Data",3,
+ bbtkCDebugMessage("data",3,
" -> No adaptor found but source and target types are both pointers : trying up or down cast"<<std::endl);
void* nptr =
mTo->bbSetInput(mInput, mFrom->bbGetOutput(mOutput),false);
}
- bbtkDebugDecTab("Process",3);
}
//==================================================================
-
+
//==================================================================
- /// Modified
- void Connection::SetModifiedStatus()
+ /// From.Output change propagation
+ void Connection::OnOutputChange(bbtk::BlackBox::Pointer, const std::string&,
+ IOStatus status)
{
- bbtkDebugMessageInc("Process",5,
- "Connection::SetModifiedStatus() ["
- <<GetFullName()<<"]"<<std::endl);
-
- if (mAdaptor) mAdaptor->bbSetModifiedStatus();
+ bbtkCDebugMessage("change",2,
+ "==> Connection::OnOutputChange("
+ <<GetIOStatusString(status)<<")"
+ <<std::endl);
+ if (mAdaptor)
+ {
+ BlackBoxInputConnector* ac = mAdaptor->bbGetInputConnectorMap().find("In")->second;
+ mAdaptor->bbSetStatusAndPropagate(ac,status);
+ }
- mTo->bbSetModifiedStatus( mTo->bbGetInputConnectorMap().find(mInput)->second );
+ mTo->bbSetStatusAndPropagate( mTo->bbGetInputConnectorMap().find(mInput)->second, status);
- bbtkDebugDecTab("Process",5);
+
}
//==================================================================
//==================================================================
void Connection::Check() const
{
- bbtkMessage("Debug",1,"** Checking Connection "<<(void*)this<<" ["<<GetFullName()<<"]"
+ bbtkMessage("debug",1,"** Checking Connection "<<(void*)this<<" ["
+ <<GetFullName()<<"]"
<<std::endl);
if (mFrom==0)
{
- bbtkMessage("Debug",2," - From = 0"<<std::endl);
+ bbtkMessage("debug",2," - From = 0"<<std::endl);
}
else
{
- bbtkMessage("Debug",2," - From : "<<mFrom->bbGetFullName()<<std::endl);
+ bbtkMessage("debug",2," - From : "<<mFrom->bbGetName()<<std::endl);
if (!mFrom->bbHasOutput(mOutput))
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- << mFrom->bbGetFullName()<<" does not have output '"
+ << mFrom->bbGetName()<<" does not have output '"
<<mOutput<<"'");
}
- bbtkMessage("Debug",2," - From : Output '"<<mOutput<<"' exists"<<std::endl);
+ bbtkMessage("debug",2," - From : Output '"<<mOutput<<"' exists"<<std::endl);
BlackBox::OutputConnectorMapType::const_iterator i
= mFrom->bbGetOutputConnectorMap().find(mOutput);
if (i== mFrom->bbGetOutputConnectorMap().end())
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- <<mFrom->bbGetFullName()<<" output '"
+ <<mFrom->bbGetName()<<" output '"
<<mOutput<<"' is not in OutputConnectorMap");
}
- bbtkMessage("Debug",2," - From : Output '"<<mOutput
+ bbtkMessage("debug",2," - From : Output '"<<mOutput
<<"' is in OutputConnectorMap"<<std::endl);
- std::vector< Connection::WeakPointer >::const_iterator j;
+ std::vector< Connection* >::const_iterator j;
+ /*
for (j = i->second->GetConnectionVector().begin();
j != i->second->GetConnectionVector().end();
++j)
{
- if ((*j).lock()==GetThisPointer<Connection>()) break;
+ if ((*j)==this) break;
}
- /*
+ */
j = find(i->second->GetConnectionVector().begin(),
i->second->GetConnectionVector().end(),
- GetThisPointer<Connection>());
- */
+ this);
+
if (j==i->second->GetConnectionVector().end())
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- << "Connection ["<<GetFullName()<<"] : "
<<" OutputConnector '"
- <<mOutput<<"' of "<<mFrom->bbGetFullName()
+ <<mOutput<<"' of "<<mFrom->bbGetName()
<<" does not point to this connection");
}
- bbtkMessage("Debug",2," - From : This connection is in OutputConnector connection vector"<<std::endl);
- bbtkMessage("Debug",1," * Box from : Check successfull"<<std::endl);
+ bbtkMessage("debug",2," - From : This connection is in OutputConnector connection vector"<<std::endl);
+ bbtkMessage("debug",2," * Box from : Check successfull"<<std::endl);
}
if (mTo==0)
{
- bbtkMessage("Debug",2," - To = 0"<<std::endl);
+ bbtkMessage("debug",2," - To = 0"<<std::endl);
}
else
{
- bbtkMessage("Debug",2," - To : "<<mTo->bbGetName()<<std::endl);
+ bbtkMessage("debug",2," - To : "<<mTo->bbGetName()<<std::endl);
// std::cout << mTo << std::endl;
// std::cout << mTo->bbGetDescriptor() << std::endl;
// std::cout << mTo->bbGetDescriptor()->GetTypeName() << std::endl;
- // mTo->bbGetFullName();
- bbtkMessage("Debug",2," - To : "<<mTo->bbGetFullName()<<std::endl);
+ // mTo->bbGetName();
+ bbtkMessage("debug",2," - To : "<<mTo->bbGetName()<<std::endl);
if (!mTo->bbHasInput(mInput))
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- <<mTo->bbGetFullName()<<" does not have input '"
+ <<mTo->bbGetName()<<" does not have input '"
<<mInput<<"'");
}
- bbtkMessage("Debug",2," - To : Input '"<<mInput<<"' exists"<<std::endl);
+ bbtkMessage("debug",2," - To : Input '"<<mInput<<"' exists"<<std::endl);
BlackBox::InputConnectorMapType::const_iterator i
= mTo->bbGetInputConnectorMap().find(mInput);
if (i== mTo->bbGetInputConnectorMap().end())
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- <<mTo->bbGetFullName()<<" input '"
+ <<mTo->bbGetName()<<" input '"
<<mInput<<"' is not in InputConnectorMap");
}
- bbtkMessage("Debug",2," - To : Input '"<<mInput
+ bbtkMessage("debug",2," - To : Input '"<<mInput
<<"' is in InputConnectorMap"<<std::endl);
if (i->second->GetConnection()==0)
{
bbtkError("** Checking Connection "<<(void*)this
<<" ["<<GetFullName()<<"] : "
- <<"Connection "<<GetFullName()<<" : "
<<" InputConnector '"
- <<mInput<<"' of "<<mTo->bbGetFullName()
+ <<mInput<<"' of "<<mTo->bbGetName()
<<" does not point to this connection");
}
- bbtkMessage("Debug",2," - To : This connection is in InputConnector connection vector"<<std::endl);
- bbtkMessage("Debug",1," * Box to : Check successfull"<<std::endl);
+ bbtkMessage("debug",2," - To : This connection is in InputConnector connection vector"<<std::endl);
+ bbtkMessage("debug",2," * Box to : Check successfull"<<std::endl);
}
}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff