]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkComplexBlackBoxDescriptor.cxx
Some indentation
[bbtk.git] / kernel / src / bbtkComplexBlackBoxDescriptor.cxx
index 2631a337def4b8099797a2ae926c023f9efb22b1..99133dace43038feb6fed70eff5dfd8ca21f921c 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkComplexBlackBoxDescriptor.cxx,v $
   Language:  C++
-  Date:      $Date: 2008/01/30 12:14:43 $
-  Version:   $Revision: 1.2 $
+  Date:      $Date: 2008/02/08 11:56:10 $
+  Version:   $Revision: 1.9 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -35,10 +35,11 @@ namespace bbtk
   ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(const std::string& name)
     : BlackBoxDescriptor()
   {
-    bbtkDebugMessageInc("Core",9,"ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(\""<<name<<"\")"<<std::endl);
+    bbtkDebugMessageInc("Kernel",9,"ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(\""<<name<<"\")"<<std::endl);
     SetTypeName(name);
+    AddToCategory("complex box");
     mPrototype = new ComplexBlackBox(name+std::string("Prototype"),this);
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //=======================================================================
 
@@ -48,11 +49,11 @@ namespace bbtk
   /// Default dtor
   ComplexBlackBoxDescriptor::~ComplexBlackBoxDescriptor()
   {
-    bbtkDebugMessageInc("Core",9,"ComplexBlackBoxDescriptor::~ComplexBlackBoxDescriptor(\""<<GetTypeName()<<"\")"<<std::endl);
+    bbtkDebugMessageInc("Kernel",9,"ComplexBlackBoxDescriptor::~ComplexBlackBoxDescriptor(\""<<GetTypeName()<<"\")"<<std::endl);
 
     delete mPrototype;
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
   }
   //=======================================================================
 
@@ -62,14 +63,14 @@ namespace bbtk
   BlackBox* ComplexBlackBoxDescriptor::CreateInstance(const std::string& name)
   {
     //bbtkError("ComplexBlackBoxDescriptor::CreateInstance not implemented");
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::CreateInstance(\""
                        <<name<<"\") ["
                        <<GetTypeName()<<"]"<<std::endl);
     
     return mPrototype->bbClone(name);
 
-    bbtkDebugDecTab("Core",5);
+    bbtkDebugDecTab("Kernel",5);
   }
   //=======================================================================
 
@@ -81,7 +82,7 @@ namespace bbtk
                                        const std::string& name
                                        )
   {
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::Add(\""
                        <<type<<"\",\""<<name<<"\") ["
                        <<GetTypeName()<<"]"<<std::endl);
@@ -95,7 +96,7 @@ namespace bbtk
     // ok : create new one
     mPrototype->bbAddBlackBox ( /*mFactory->Create*/ NewBlackBox(type,name) );
 
-    bbtkDebugDecTab("Core",5);
+    bbtkDebugDecTab("Kernel",5);
   }
   //=======================================================================
 
@@ -103,7 +104,7 @@ namespace bbtk
   /// Adds a black box to the execution list 
   void ComplexBlackBoxDescriptor::AddToExecutionList ( const std::string& box)
   {
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::AddToExecutionList(\""
                        <<box<<"\" ["
                        <<GetTypeName()<<"]"<<std::endl);
@@ -116,7 +117,7 @@ namespace bbtk
     // ok 
     mPrototype->bbAddToExecutionList ( box  );
 
-    bbtkDebugDecTab("Core",5);
+    bbtkDebugDecTab("Kernel",5);
     }
 
 
@@ -128,7 +129,7 @@ namespace bbtk
                                            const std::string& input
                                            )
   {
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::Connect(\""
                        <<from<<"\",\""<<output<<"\",\""
                        <<to<<"\",\""<<input
@@ -150,7 +151,7 @@ namespace bbtk
 
     mPrototype->bbAddConnection(c);
 
-    bbtkDebugDecTab("Core",5);
+    bbtkDebugDecTab("Kernel",5);
   }
   //=======================================================================
 
@@ -162,7 +163,7 @@ namespace bbtk
                                                const std::string& input,
                                                const std::string& help)
   {
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::DefineInput(\""
                        <<name<<"\",\""<<box<<"\",\""
                        <<input<<"\",\""<<help
@@ -181,14 +182,16 @@ namespace bbtk
                  <<input<<"\"");
       }
     
-    AddInputDescriptor ( new ComplexBlackBoxInputDescriptor ( name,
-                                                             help,
-                                                             box,
-                                                             input,
-                                                             bb->bbGetInputType(input)));
-                                                            
+    AddInputDescriptor ( new ComplexBlackBoxInputDescriptor 
+                        ( typeid(ComplexBlackBoxDescriptor),
+                          name,
+                          help,
+                          box,
+                          input,
+                          bb->bbGetInputType(input)));
     
-    bbtkDebugDecTab("Core",5);
+    
+    bbtkDebugDecTab("Kernel",5);
   }
   //=======================================================================
 
@@ -199,7 +202,7 @@ namespace bbtk
                                                 const std::string& output,
                                                 const std::string& help)
   {
-    bbtkDebugMessageInc("Core",5,
+    bbtkDebugMessageInc("Kernel",5,
                        "ComplexBlackBoxDescriptor::DefineOutput(\""
                        <<name<<"\",\""<<box<<"\",\""
                        <<output<<"\",\""<<help
@@ -219,14 +222,15 @@ namespace bbtk
       }
     
     AddOutputDescriptor ( new ComplexBlackBoxOutputDescriptor 
-                         ( name,
+                         ( typeid(ComplexBlackBoxDescriptor),
+                           name,
                            help,
                            box,
                            output,
                            bb->bbGetOutputType(output)));
     
     
-    bbtkDebugDecTab("Core",5);
+    bbtkDebugDecTab("Kernel",5);
   }
   //=======================================================================
 
@@ -256,7 +260,7 @@ namespace bbtk
                                                   int detail, int level,
                                                   const std::string& output_dir, bool relative_link)
   {
-    bbtkDebugMessageInc("Core",9,
+    bbtkDebugMessageInc("Kernel",9,
                        "ComplexBlackBoxDescriptor::InsertHtmlHelp() ["
                        <<GetTypeName()<<"]"<<std::endl);
     
@@ -277,13 +281,17 @@ namespace bbtk
 
 
     std::string descr = GetDescription();
-    //Utilities::html_format(descr);
+    Utilities::html_format(descr);
     
     std::string author = GetAuthor();
     Utilities::html_format(author);
     
-    std::string keyword = GetKeyword();
-    Utilities::html_format(keyword);
+    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;'> " 
@@ -292,14 +300,20 @@ namespace bbtk
     (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> Keyword(s) </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  " 
-        << keyword << "</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>&nbsp;\n";
+      }
+    s << "</TD></TR>\n";      
     std::string inc = GetScriptFileName();
     if (inc.size()>0) 
       {
-    (s) << "<TR><TD style='vertical-align: top;'><b> Include </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  " 
-      << inc << "</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 ";
+       s << inc << "&nbsp;&nbsp;<a href=\"../../../bbs/"<<inc<<"\">[source]</a>";
+       s << "</TD></TR>\n";
        
       }
     
@@ -307,7 +321,7 @@ namespace bbtk
        
     if (B.size()) 
     {
-          (s) << "<TR><TD style='vertical-align: top;'><b> Dependencies </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  ";
+          (s) << "<TR><TD style='vertical-align: top;'><b> Uses </b></TD><TD style='vertical-align: top;'> : </TD><TD style='vertical-align: top;'>  ";
 
           std::set<BlackBoxDescriptor*> pdeps;
           ComplexBlackBox::BlackBoxMapType::const_iterator b;
@@ -367,7 +381,7 @@ namespace bbtk
        Utilities::html_format(type);
        
        std::string descr(in->second->GetDescription());
-       //Utilities::html_format(descr);
+       Utilities::html_format(descr);
 
        (s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
          << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
@@ -400,7 +414,7 @@ namespace bbtk
        Utilities::html_format(type);
        
        std::string descr(o->second->GetDescription());
-       //Utilities::html_format(descr);
+       Utilities::html_format(descr);
        
        (s) << "<TR><TD style='vertical-align: top;'><B><PRE> "<<name<<" </PRE></B></TD>"
          << "<TD style='vertical-align: top;'><I><PRE> "<<type<<" </PRE></I></TD>"
@@ -412,7 +426,7 @@ namespace bbtk
     //------------
     // End
 
-    bbtkDebugDecTab("Core",9);
+    bbtkDebugDecTab("Kernel",9);
    }
   //=========================================================================
  
@@ -423,9 +437,9 @@ namespace bbtk
     if (full) bbtkMessage("Help",1,"Complex Black Box <"<<
                          GetPackage()->GetName()<<"::"
                          <<GetTypeName()<<">"<<std::endl);
-    bbtkMessage("Help",1," "              << GetDescription() <<std::endl);
-    bbtkMessage("Help",1," By : "         << GetAuthor()      <<std::endl);
-    bbtkMessage("Help",1," Keyword(s) : " << GetKeyword()     <<std::endl);    
+    bbtkMessage("Help",1," "                << GetDescription() <<std::endl);
+    bbtkMessage("Help",1," By : "           << GetAuthor()      <<std::endl);
+    bbtkMessage("Help",1," Category(s) : "  << GetCategory()     <<std::endl);    
     if (mInput.size()) 
       bbtkMessage("Help",1," * Inputs : "<<std::endl);
     else