-/*=========================================================================
-
+/*=========================================================================
Program: bbtk
Module: $RCSfile: bbtkBlackBoxDescriptor.cxx,v $
Language: C++
- Date: $Date: 2008/02/08 07:39:49 $
- Version: $Revision: 1.12 $
-
- 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: 2009/12/08 14:10:36 $
+ Version: $Revision: 1.22 $
=========================================================================*/
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+* 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.
+* ------------------------------------------------------------------------ */
+
+
/**
* \file
* \brief Class bbtk::BlackBoxDescriptor : (abstract) describes a BlackBox (name, description, author) and is able to create an instance of it.
namespace bbtk
{
-
+
+ typedef Package::Pointer PackagePointer;
+
+#define bbtkDMessage(key,level,mess) \
+ bbtkMessage(key,level,"["<<GetFullTypeName()<<"] "<<mess)
+#define bbtkDDebugMessage(key,level,mess) \
+ bbtkDebugMessage(key,level,"["<<GetFullTypeName()<<"] "<<mess)
+
+
//=========================================================================
/// Default ctor
BlackBoxDescriptor::BlackBoxDescriptor()
mAuthor(""),
mCategory(""),
mKind(STANDARD),
- mPackage(NULL)
+ mPackage()
{
- bbtkDebugMessage("Kernel",9,
- "BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
+ bbtkDDebugMessage("object",4,
+ "==> BlackBoxDescriptor()"<<std::endl);
+ bbtkDDebugMessage("object",4,
+ "<== BlackBoxDescriptor()"<<std::endl);
}
//=========================================================================
+ //=========================================================================
+ /// Default ctor
+ BlackBoxDescriptor::BlackBoxDescriptor(const BlackBoxDescriptor&)
+ {
+ }
//=========================================================================
/// Dtor
BlackBoxDescriptor::~BlackBoxDescriptor()
{
- bbtkDebugMessageInc("Kernel",9,
- "BlackBoxDescriptor::~BlackBoxDescriptor() ["
- <<mTypeName<<"]"<<std::endl);
+ bbtkDDebugMessage("object",4,
+ "==> ~BlackBoxDescriptor()"
+ <<std::endl);
// deletes all I/O descriptors
InputDescriptorMapType::iterator i;
OutputDescriptorMapType::iterator o;
for (o=mOutput.begin(); o!=mOutput.end(); ++o) delete o->second;
- bbtkDebugDecTab("Kernel",9);
+ bbtkDDebugMessage("object",4,
+ "<== ~BlackBoxDescriptor()"
+ <<std::endl);
+ }
+ //=========================================================================
+
+ /*
+ //=======================================================================
+ /// Release
+ void BlackBoxDescriptor::Release(BlackBoxDescriptor::WeakPointer desc)
+ {
+ bbtkMessage("object",2,"==> BlackBoxDescriptor::Release('"
+ <<desc.lock()->GetTypeName()<<"')"<<std::endl);
+ long c = desc.use_count();
+ bbtkMessage("object",3," - ref count = "<<c<<std::endl);
+ // If only one ref
+ if ((c == 1) && (desc.lock()->mPackage))
+ {
+ bbtkMessage("object",2," --> No more instance alive = releasing from package"<<std::endl);
+
+ Package::WeakPointer pack = desc.lock()->mPackage;
+ Package::ReleaseBlackBoxDescriptor(pack,desc);
+ }
+ else
+ {
+ bbtkMessage("object",2," --> Still some instances alive = Keeping it alive"<<std::endl);
+ }
+ bbtkMessage("object",2,"<== BlackBoxDescriptor::Release('"
+ <<desc.lock()->GetTypeName()<<"')"<<std::endl);
+
+ }
+ //=========================================================================
+ */
+
+ /*
+ //=========================================================================
+ /// Dtor
+ void BlackBoxDescriptor::UnReference()
+ {
+ bbtkDDebugMessageInc("kernel",1,
+ "BlackBoxDescriptor::UnReference() ["
+ <<mTypeName<<"] #"<<mRefCount-1<<std::endl);
+ mRefCount--;
+ if (mRefCount<=0)
+ {
+ bbtkDDebugMessage("kernel",1,"--> Destructing BlackBoxDescriptor ["<<mTypeName<<"]"<<std::endl);
+ delete this;
+ }
+ }
+ //=========================================================================
+ */
+ //=========================================================================
+ /// Check
+ void BlackBoxDescriptor::Check(bool) const
+ {
+
}
//=========================================================================
/// Adds the string to the BlackBox description
void BlackBoxDescriptor::AddToDescription( const std::string& s, bool clear)
{
- bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToDescription(\""<<s<<
- "\") ["<<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::AddToDescription(\""
+ <<s<<"\")"<<std::endl);
if (clear) mDescription = s;
else mDescription += s;
}
/// Adds the string to the BlackBox author list
void BlackBoxDescriptor::AddToAuthor( const std::string& s, bool clear)
{
- bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToAuthor(\""<<s<<"\") ["
- <<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::AddToAuthor(\""
+ <<s<<"\")"
+ <<std::endl);
if (clear) mAuthor = s;
else mAuthor += s;
}
/// Adds the string to the BlackBox category list
void BlackBoxDescriptor::AddToCategory( const std::string& s, bool clear)
{
- bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToCategory(\""<<s<<"\") ["
- <<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::AddToCategory(\""
+ <<s<<"\")"
+ <<std::endl);
if (clear) mCategory = s;
else mCategory += s;
mCategory += ";";
const BlackBoxDescriptor::InputDescriptor*
BlackBoxDescriptor::GetInputDescriptor(const std::string & name) const
{
- bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetInputDescriptor('"
- <<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::GetInputDescriptor('"
+ <<name<<"')"<<std::endl);
InputDescriptorMapType::const_iterator i;
i = mInput.find(name);
{
bbtkError("input '"<<name<<"' does not exist");
}
- bbtkDebugDecTab("Kernel",9);
+
return i->second;
}
//=========================================================================
const BlackBoxDescriptor::OutputDescriptor*
BlackBoxDescriptor::GetOutputDescriptor(const std::string & name) const
{
- bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetOutputDescriptor('"
- <<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::GetOutputDescriptor('"
+ <<name<<"')"<<std::endl);
OutputDescriptorMapType::const_iterator i;
i = mOutput.find(name);
if ( i == mOutput.end() )
{
- bbtkError("output '"<<name<<"' does not exist");
+ bbtkError("output '"<<name<<"' does not exist");
}
- bbtkDebugDecTab("Kernel",9);
+
return i->second;
}
//=========================================================================
//=========================================================================
void BlackBoxDescriptor::GetHelp(bool full) const
{
- bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetHelp() ["<<GetTypeName()<<"]"<<std::endl);
- if (GetPackage())
- {
- bbtkMessage("Help",1,"Black Box <"<<
- GetPackage()->GetName()<<"::"<<GetTypeName()<<">"<<std::endl);
- }
- else
- {
- bbtkMessage("Help",1,"Black Box <::"<<GetTypeName()<<">"<<std::endl);
- }
- bbtkMessage("Help",1," " <<GetDescription()<<std::endl);
- bbtkMessage("Help",1," By : " <<GetAuthor() <<std::endl);
- bbtkMessage("Help",1," Categories : " <<GetCategory() <<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::GetHelp()"
+ <<std::endl);
+
+ bbtkMessage("help",1,"Black Box <"<<GetFullTypeName()<<">"<<std::endl);
+ bbtkMessage("help",1," " <<GetDescription()<<std::endl);
+ bbtkMessage("help",1," By : " <<GetAuthor() <<std::endl);
+ bbtkMessage("help",1," Categories : " <<GetCategory() <<std::endl);
if (mInput.size())
- bbtkMessage("Help",1," * Inputs : "<<std::endl);
+ bbtkMessage("help",1," * Inputs : "<<std::endl);
else
- bbtkMessage("Help",1," * No inputs"<<std::endl);
+ bbtkMessage("help",1," * No inputs"<<std::endl);
InputDescriptorMapType::const_iterator i;
unsigned int namelmax = 0;
unsigned int typelmax = 0;
+ unsigned int natlmax = 0;
for ( i = mInput.begin(); i != mInput.end(); ++i )
{
if (i->second->GetName().size()>namelmax)
namelmax = i->second->GetName().size();
if (i->second->GetHumanTypeName().size()>typelmax)
typelmax = i->second->GetHumanTypeName().size();
+ if (i->second->GetNature().size()>natlmax)
+ natlmax = i->second->GetNature().size();
}
OutputDescriptorMapType::const_iterator o;
for ( o = mOutput.begin(); o != mOutput.end(); ++o )
namelmax = o->second->GetName().size();
if (o->second->GetHumanTypeName().size()>typelmax)
typelmax = o->second->GetHumanTypeName().size();
+ if (o->second->GetNature().size()>natlmax)
+ natlmax = o->second->GetNature().size();
}
//
for ( i = mInput.begin(); i != mInput.end(); ++i )
std::string type(i->second->GetHumanTypeName());
type += ">";
type.append(1+typelmax-type.size(),' ');
- bbtkMessage("Help",1,
- " '"<<name
- <<" <"<<type
- <<" : "<<i->second->GetDescription()<<std::endl);
+ std::string nature(i->second->GetNature());
+ nature += "]";
+ nature.append(1+natlmax-nature.size(),' ');
+ bbtkMessage("help",1,
+ " '"<<name
+ <<" <"<<type
+ <<" ["<<nature
+ <<" : "<<i->second->GetDescription()<<std::endl);
}
if (mOutput.size())
- bbtkMessage("Help",1," * Outputs : "<<std::endl);
+ bbtkMessage("help",1," * Outputs : "<<std::endl);
else
- bbtkMessage("Help",1," * No outputs"<<std::endl);
+ bbtkMessage("help",1," * No outputs"<<std::endl);
for ( o = mOutput.begin(); o != mOutput.end(); ++o )
{
std::string name(o->second->GetName());
std::string type(o->second->GetHumanTypeName());
type += ">";
type.append(1+typelmax-type.size(),' ');
- bbtkMessage("Help",1,
+ std::string nature(o->second->GetNature());
+ nature += "]";
+ nature.append(1+natlmax-nature.size(),' ');
+ bbtkMessage("help",1,
" '"<<name
- <<" <"<<type
- <<" : "<<o->second->GetDescription()<<std::endl);
+ <<" <"<<type
+ <<" ["<<nature
+ <<" : "<<o->second->GetDescription()<<std::endl);
}
- bbtkDebugDecTab("Kernel",9);
-
}
//=========================================================================
-
+
+ //=========================================================================
+ /// Returns the full name of the **TYPE** of the black box (+package name)
+ std::string BlackBoxDescriptor::GetFullTypeName() const
+ {
+ if (GetPackage()!=0) return GetPackage()->GetName() + "::" + mTypeName;
+ return "::" + mTypeName;
+ }
+ //=========================================================================
+
//=========================================================================
void BlackBoxDescriptor::InsertHtmlHelp ( std::ofstream& s,
int detail, int level,
const std::string& output_dir,
bool relative_link )
{
- bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::InsertHtmlHelp() ["<<GetTypeName()<<"]"<<std::endl);
+ bbtkDDebugMessage("kernel",9,"BlackBoxDescriptor::InsertHtmlHelp()"
+ <<std::endl);
//-------------
// General info
std::string descr = GetDescription();
- Utilities::html_format(descr);
+ //Utilities::html_format(descr);
std::string author = GetAuthor();
Utilities::html_format(author);
col = ubbcol;
iotype = 1;
}
+#ifdef USE_WXWIDGETS
else if (in->second->GetCreatorTypeInfo() ==
typeid(WxBlackBoxDescriptor))
{
col = wxbbcol;
iotype = 2;
}
+#endif
std::string name(in->second->GetName());
Utilities::html_format(name);
Utilities::html_format(type);
std::string descr(in->second->GetDescription());
- Utilities::html_format(descr);
-
+ //Utilities::html_format(descr);
+
+/*EED 10/11/2009
std::string out =
"<TR><TD style='vertical-align: top;' bgcolor=\"" + col
+"\"><B><PRE> "+name+" </PRE></B></TD>"
+"\"><I><PRE> "+type+" </PRE></I></TD>"
+ "<TD style='vertical-align: top;' bgcolor=\""+col
+"\">"+descr+"</TD></TR>\n";
-
+*/
+
+ std::string out =
+ "<TR><TD style='vertical-align: top;' bgcolor=\"" + col
+ +"\"><B><PRE> "+name+" </PRE></B></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\"><I><PRE> "+descr+" </PRE></I></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\">"+type+"</TD></TR>\n";
+
if (iotype==0) user_defined.push_back(out);
else if (iotype==1) ubb_defined.push_back(out);
else if (iotype==2) wxbb_defined.push_back(out);
col = ubbcol;
iotype = 1;
}
+#ifdef USE_WXWIDGETS
else if (o->second->GetCreatorTypeInfo() ==
typeid(WxBlackBoxDescriptor))
{
col = wxbbcol;
iotype = 2;
}
+#endif
std::string name(o->second->GetName());
Utilities::html_format(name);
Utilities::html_format(type);
std::string descr(o->second->GetDescription());
- Utilities::html_format(descr);
+ //Utilities::html_format(descr);
+/*EED 10/11/2009
std::string out =
"<TR><TD style='vertical-align: top;' bgcolor=\"" + col
+"\"><B><PRE> "+name+" </PRE></B></TD>"
+"\"><I><PRE> "+type+" </PRE></I></TD>"
+ "<TD style='vertical-align: top;' bgcolor=\""+col
+"\">"+descr+"</TD></TR>\n";
-
+*/
+ std::string out =
+ "<TR><TD style='vertical-align: top;' bgcolor=\"" + col
+ +"\"><B><PRE> "+name+" </PRE></B></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\"><I><PRE> "+descr+" </PRE></I></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\">"+type+"</TD></TR>\n";
+
if (iotype==0) user_defined.push_back(out);
else if (iotype==1) ubb_defined.push_back(out);
else if (iotype==2) wxbb_defined.push_back(out);
//------------
// End
- bbtkDebugDecTab("Kernel",9);
+
}
//=========================================================================