Program: bbtk
Module: $RCSfile: bbtkBlackBoxDescriptor.cxx,v $
Language: C++
- Date: $Date: 2008/01/22 15:02:00 $
- Version: $Revision: 1.1 $
+ Date: $Date: 2008/02/19 18:40:09 $
+ Version: $Revision: 1.14 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "bbtkMessageManager.h"
#include "bbtkPackage.h"
#include "bbtkUtilities.h"
+#include "bbtkAtomicBlackBoxDescriptor.h"
+#include "bbtkWxBlackBox.h"
namespace bbtk
{
: mTypeName("Unknown"),
mDescription(""),
mAuthor(""),
- mCategory(STANDARD),
+ mCategory(""),
+ mKind(STANDARD),
mPackage(NULL)
{
- bbtkDebugMessage("Core",9,
+ bbtkDebugMessage("Kernel",9,
"BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
}
//=========================================================================
/// Dtor
BlackBoxDescriptor::~BlackBoxDescriptor()
{
- bbtkDebugMessageInc("Core",9,
+ bbtkDebugMessageInc("Kernel",9,
"BlackBoxDescriptor::~BlackBoxDescriptor() ["
<<mTypeName<<"]"<<std::endl);
OutputDescriptorMapType::iterator o;
for (o=mOutput.begin(); o!=mOutput.end(); ++o) delete o->second;
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//=========================================================================
//=========================================================================
- /// Adds the string to the BlackBox's description
+ /// Adds the string to the BlackBox description
void BlackBoxDescriptor::AddToDescription( const std::string& s, bool clear)
{
- bbtkDebugMessage("Core",9,"BlackBoxDescriptor::AddToDescription(\""<<s<<
+ bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToDescription(\""<<s<<
"\") ["<<GetTypeName()<<"]"<<std::endl);
if (clear) mDescription = s;
else mDescription += s;
}
- /// Adds the string to the BlackBox's author list
+ //=========================================================================
+
+ //=========================================================================
+ /// Adds the string to the BlackBox author list
void BlackBoxDescriptor::AddToAuthor( const std::string& s, bool clear)
{
- bbtkDebugMessage("Core",9,"BlackBoxDescriptor::AddToAuthor(\""<<s<<"\") ["
+ bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToAuthor(\""<<s<<"\") ["
<<GetTypeName()<<"]"<<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);
+ if (clear) mCategory = s;
+ else mCategory += s;
+ mCategory += ";";
+ }
+ //=========================================================================
+
//=========================================================================
const BlackBoxDescriptor::InputDescriptor*
BlackBoxDescriptor::GetInputDescriptor(const std::string & name) const
{
- bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetInputDescriptor('"
+ bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetInputDescriptor('"
<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
InputDescriptorMapType::const_iterator i;
i = mInput.find(name);
if ( i == mInput.end() )
- {
- bbtkError("input '"<<name<<"' does not exist");
- }
- bbtkDebugDecTab("Core",9);
+ {
+ bbtkError("input '"<<name<<"' does not exist");
+ }
+ bbtkDebugDecTab("Kernel",9);
return i->second;
}
//=========================================================================
const BlackBoxDescriptor::OutputDescriptor*
BlackBoxDescriptor::GetOutputDescriptor(const std::string & name) const
{
- bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetOutputDescriptor('"
+ bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetOutputDescriptor('"
<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
OutputDescriptorMapType::const_iterator i;
i = mOutput.find(name);
if ( i == mOutput.end() )
- {
- bbtkError("output '"<<name<<"' does not exist");
- }
- bbtkDebugDecTab("Core",9);
+ {
+ bbtkError("output '"<<name<<"' does not exist");
+ }
+ bbtkDebugDecTab("Kernel",9);
return i->second;
}
//=========================================================================
//=========================================================================
void BlackBoxDescriptor::GetHelp(bool full) const
{
- bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::GetHelp() ["<<GetTypeName()<<"]"<<std::endl);
+ 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 <"<<
+ 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," " <<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);
else
unsigned int namelmax = 0;
unsigned int typelmax = 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->GetName().size()>namelmax)
+ namelmax = i->second->GetName().size();
+ if (i->second->GetHumanTypeName().size()>typelmax)
+ typelmax = i->second->GetHumanTypeName().size();
+ }
OutputDescriptorMapType::const_iterator o;
for ( o = mOutput.begin(); o != mOutput.end(); ++o )
- {
- if (o->second->GetName().size()>namelmax)
- namelmax = o->second->GetName().size();
- if (o->second->GetHumanTypeName().size()>typelmax)
- typelmax = o->second->GetHumanTypeName().size();
- }
+ {
+ if (o->second->GetName().size()>namelmax)
+ namelmax = o->second->GetName().size();
+ if (o->second->GetHumanTypeName().size()>typelmax)
+ typelmax = o->second->GetHumanTypeName().size();
+ }
//
for ( i = mInput.begin(); i != mInput.end(); ++i )
- {
- std::string name(i->second->GetName());
- name += "'";
- name.append(1+namelmax-name.size(),' ');
- std::string type(i->second->GetHumanTypeName());
- type += ">";
- type.append(1+typelmax-type.size(),' ');
- bbtkMessage("Help",1,
+ {
+ std::string name(i->second->GetName());
+ name += "'";
+ name.append(1+namelmax-name.size(),' ');
+ std::string type(i->second->GetHumanTypeName());
+ type += ">";
+ type.append(1+typelmax-type.size(),' ');
+ bbtkMessage("Help",1,
" '"<<name
<<" <"<<type
<<" : "<<i->second->GetDescription()<<std::endl);
- }
+ }
if (mOutput.size())
bbtkMessage("Help",1," * Outputs : "<<std::endl);
else
bbtkMessage("Help",1," * No outputs"<<std::endl);
for ( o = mOutput.begin(); o != mOutput.end(); ++o )
- {
- std::string name(o->second->GetName());
- name += "'";
- name.append(1+namelmax-name.size(),' ');
- std::string type(o->second->GetHumanTypeName());
- type += ">";
- type.append(1+typelmax-type.size(),' ');
- bbtkMessage("Help",1,
+ {
+ std::string name(o->second->GetName());
+ name += "'";
+ name.append(1+namelmax-name.size(),' ');
+ std::string type(o->second->GetHumanTypeName());
+ type += ">";
+ type.append(1+typelmax-type.size(),' ');
+ bbtkMessage("Help",1,
" '"<<name
<<" <"<<type
<<" : "<<o->second->GetDescription()<<std::endl);
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
const std::string& output_dir,
bool relative_link )
{
- bbtkDebugMessageInc("Core",9,"BlackBoxDescriptor::InsertHtmlHelp() ["<<GetTypeName()<<"]"<<std::endl);
+ bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::InsertHtmlHelp() ["<<GetTypeName()<<"]"<<std::endl);
//-------------
// General info
std::string descr = GetDescription();
- //Utilities::html_format(descr);
+ Utilities::html_format(descr);
std::string author = GetAuthor();
Utilities::html_format(author);
+
+ std::vector<std::string> categories;
+ // Split the category string
+ std::string delimiters = ";,";
+ Utilities::SplitString(GetCategory(),
+ delimiters,categories);
+
(s) << "<p><TABLE cellspacing=0 cellpadding=3>\n";
(s) << "<TR><TD style='vertical-align: top;'><b> Description </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> "
<< descr << "</TD></TR>\n";
(s) << "<TR><TD style='vertical-align: top;'><b> Author(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> "
<< author << "</TD></TR>\n";
+ (s) << "<TR><TD style='vertical-align: top;'><b> Category(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> ";
+ std::vector<std::string>::iterator ci;
+ for (ci=categories.begin(); ci!=categories.end(); ++ci)
+ {
+ s << "<a href=\"../index-category.html#"<< *ci <<"\">" << *ci
+ << "</a> \n";
+ }
+ s << "</TD></TR>\n";
+
+ (s) << "<TR><TD style='vertical-align: top;'><b> To use it </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'> include "
+ << GetPackage()->GetName() << "</TD></TR>\n";
(s) << "</TABLE>\n";
-
+
//-------------
// Graph
//i->second->InsertHTMLGraph( &s , detail,level,dir);
//-------------
// Inputs
- std::string col("#CCCCFF");
-
+ std::string titlecol("#BBBBFF");
+ std::string usercol("#FFFFFF");
+ std::string ubbcol("#DDFFFF");
+ std::string wxbbcol("#EEFFFF");
+
+
// (s) << "<h3 class=\"subsection\">Inputs</h3>\n";
(s) << "<p><TABLE border=1 cellspacing=0 cellpadding=3>\n";
- (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<col
+ (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<titlecol
<<"\">Inputs</TD></TR>\n";
+
+ std::vector<std::string> user_defined;
+ std::vector<std::string> ubb_defined;
+ std::vector<std::string> wxbb_defined;
+
const BlackBoxDescriptor::InputDescriptorMapType& imap =
GetInputDescriptorMap();
-
InputDescriptorMapType::const_iterator in;
-
for ( in = imap.begin(); in != imap.end(); ++in )
- {
- std::string name(in->second->GetName());
- Utilities::html_format(name);
-
- std::string type("<");
- type += in->second->GetTypeName();
- type += ">";
- Utilities::html_format(type);
-
- std::string descr(in->second->GetDescription());
- //Utilities::html_format(descr);
+ {
+ // Skips system-defined inputs
+ std::string col(usercol);
+ int iotype = 0;
+ if (in->second->GetCreatorTypeInfo() ==
+ typeid(AtomicBlackBoxDescriptor))
+ {
+ col = ubbcol;
+ iotype = 1;
+ }
+ else if (in->second->GetCreatorTypeInfo() ==
+ typeid(WxBlackBoxDescriptor))
+ {
+ col = wxbbcol;
+ iotype = 2;
+ }
+
+ std::string name(in->second->GetName());
+ Utilities::html_format(name);
+
+ std::string type("<");
+ type += in->second->GetTypeName();
+ type += ">";
+ Utilities::html_format(type);
+
+ std::string descr(in->second->GetDescription());
+ Utilities::html_format(descr);
+
+ 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> "+type+" </PRE></I></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\">"+descr+"</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);
+
+ }
+
+ std::vector<std::string>::iterator hi;
+ for (hi=user_defined.begin();hi!=user_defined.end();++hi) s << *hi;
+ for (hi=wxbb_defined.begin();hi!=wxbb_defined.end();++hi) s << *hi;
+ for (hi=ubb_defined.begin();hi!=ubb_defined.end();++hi) s << *hi;
+
+ user_defined.clear();
+ ubb_defined.clear();
+ wxbb_defined.clear();
- (s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
- << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
- << "<TD style='vertical-align: top;'>"<<descr<<"</TD></TR>\n";
-
- }
- // (s) << "</TABLE>\n";
-
-
//-------------
// Outputs
// (s) << "<h3 class=\"subsection\">Outputs</h3>\n";
// (s) << "<TABLE border=1 cellspacing=0>\n";
- (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<col
+ (s) << "<TR><TD colspan=3 align=center bgcolor=\""<<titlecol
<<"\">Outputs</TD></TR>\n";
const BlackBoxDescriptor::OutputDescriptorMapType& omap =
for ( o = omap.begin(); o != omap.end(); ++o )
{
+ std::string col(usercol);
+ int iotype = 0;
+ if (o->second->GetCreatorTypeInfo() ==
+ typeid(AtomicBlackBoxDescriptor))
+ {
+ col = ubbcol;
+ iotype = 1;
+ }
+ else if (o->second->GetCreatorTypeInfo() ==
+ typeid(WxBlackBoxDescriptor))
+ {
+ col = wxbbcol;
+ iotype = 2;
+ }
+
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);
+ 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> "+type+" </PRE></I></TD>"
+ + "<TD style='vertical-align: top;' bgcolor=\""+col
+ +"\">"+descr+"</TD></TR>\n";
- (s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
- << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
- << "<TD style='vertical-align: top;'>"<<descr<<"</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);
}
- (s) << "</TABLE>\n";
+
+ for (hi=user_defined.begin();hi!=user_defined.end();++hi) s << *hi;
+ for (hi=wxbb_defined.begin();hi!=wxbb_defined.end();++hi) s << *hi;
+ for (hi=ubb_defined.begin();hi!=ubb_defined.end();++hi) s << *hi;
+ (s) << "</TABLE>\n";
+
//------------
// End
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//=========================================================================
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff