X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkBlackBoxDescriptor.cxx;h=e4318a7a3dd3d7259bef6bb5486509d2cc76a89e;hb=d8041d1ef54a73acc2306557435f6b04edf60daf;hp=6f5ab20e7c7cfa0c4d1571c3e120fa500de566fb;hpb=f5db17702a2c51a5933f6c556d070167e4db9cfd;p=bbtk.git

diff --git a/kernel/src/bbtkBlackBoxDescriptor.cxx b/kernel/src/bbtkBlackBoxDescriptor.cxx
index 6f5ab20..e4318a7 100644
--- a/kernel/src/bbtkBlackBoxDescriptor.cxx
+++ b/kernel/src/bbtkBlackBoxDescriptor.cxx
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkBlackBoxDescriptor.cxx,v $
   Language:  C++
-  Date:      $Date: 2008/02/07 07:58:53 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2008/05/06 13:45:12 $
+  Version:   $Revision: 1.17 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -29,7 +29,11 @@
 
 namespace bbtk
 {
-  
+
+  typedef Package::Pointer PackagePointer;
+
+
+
   //=========================================================================
   /// Default ctor
   BlackBoxDescriptor::BlackBoxDescriptor()  
@@ -38,20 +42,27 @@ namespace bbtk
       mAuthor(""),
       mCategory(""),
       mKind(STANDARD),
-      mPackage(NULL)
+      mPackage()
   {
-    bbtkDebugMessage("Kernel",9,
-		     "BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
+    bbtkDebugMessage("object",4,
+		     "==> BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
+   bbtkDebugMessage("object",4,
+		     "<== BlackBoxDescriptor::BlackBoxDescriptor()"<<std::endl);
   }
   //=========================================================================
 
+  //=========================================================================
+  /// Default ctor
+  BlackBoxDescriptor::BlackBoxDescriptor(const BlackBoxDescriptor&)  
+  {
+  }
   //=========================================================================
   /// Dtor
   BlackBoxDescriptor::~BlackBoxDescriptor()
   {
-    bbtkDebugMessageInc("Kernel",9,
-			"BlackBoxDescriptor::~BlackBoxDescriptor() ["
-			<<mTypeName<<"]"<<std::endl);
+    bbtkDebugMessage("object",4,
+		     "==> BlackBoxDescriptor::~BlackBoxDescriptor() ["
+		     <<mTypeName<<"]"<<std::endl);
 
     // deletes all I/O descriptors
     InputDescriptorMapType::iterator i;
@@ -59,7 +70,62 @@ namespace bbtk
     OutputDescriptorMapType::iterator o;
     for (o=mOutput.begin(); o!=mOutput.end(); ++o) delete o->second;
 
-    bbtkDebugDecTab("Kernel",9);
+    bbtkDebugMessage("object",4,
+		     "<== BlackBoxDescriptor::~BlackBoxDescriptor() ["
+		     <<mTypeName<<"]"<<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()
+  {
+    bbtkDebugMessageInc("Kernel",1,
+			"BlackBoxDescriptor::UnReference() ["
+			<<mTypeName<<"] #"<<mRefCount-1<<std::endl);
+    mRefCount--;
+    if (mRefCount<=0) 
+      {
+	bbtkDebugMessage("Kernel",1,"--> Destructing BlackBoxDescriptor ["<<mTypeName<<"]"<<std::endl);
+	delete this;
+      }
+  }
+  //=========================================================================
+  */
+  //=========================================================================
+  /// Check
+  void BlackBoxDescriptor::Check(bool) const
+  {
+    
   }
   //=========================================================================
 
@@ -68,7 +134,7 @@ namespace bbtk
   void BlackBoxDescriptor::AddToDescription( const std::string& s, bool clear)
   {
     bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToDescription(\""<<s<<
-		     "\") ["<<GetTypeName()<<"]"<<std::endl);
+		     "\") ["<<GetFullTypeName()<<"]"<<std::endl);
     if (clear) mDescription = s; 
     else mDescription += s;
    }
@@ -79,7 +145,7 @@ namespace bbtk
   void BlackBoxDescriptor::AddToAuthor( const std::string& s, bool clear)
   {
     bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToAuthor(\""<<s<<"\") ["
-		     <<GetTypeName()<<"]"<<std::endl);
+		     <<GetFullTypeName()<<"]"<<std::endl);
     if (clear) mAuthor = s;
     else mAuthor += s;
   }
@@ -90,7 +156,7 @@ namespace bbtk
   void BlackBoxDescriptor::AddToCategory( const std::string& s, bool clear)
   {
     bbtkDebugMessage("Kernel",9,"BlackBoxDescriptor::AddToCategory(\""<<s<<"\") ["
-		     <<GetTypeName()<<"]"<<std::endl);  
+		     <<GetFullTypeName()<<"]"<<std::endl);  
     if (clear) mCategory = s;
     else mCategory += s;
     mCategory += ";";
@@ -102,7 +168,7 @@ namespace bbtk
   BlackBoxDescriptor::GetInputDescriptor(const std::string & name) const
   {
     bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetInputDescriptor('"
-			<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
+			<<name<<"') ["<<GetFullTypeName()<<"]"<<std::endl);
 
     InputDescriptorMapType::const_iterator i;
     i = mInput.find(name);
@@ -120,7 +186,7 @@ namespace bbtk
   BlackBoxDescriptor::GetOutputDescriptor(const std::string & name) const
   {
     bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetOutputDescriptor('"
-			<<name<<"') ["<<GetTypeName()<<"]"<<std::endl);
+			<<name<<"') ["<<GetFullTypeName()<<"]"<<std::endl);
 
     OutputDescriptorMapType::const_iterator i;
     i = mOutput.find(name);
@@ -136,16 +202,9 @@ namespace bbtk
   //=========================================================================
   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);
-	 }
+    bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::GetHelp() ["<<GetFullTypeName()<<"]"<<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);
@@ -156,12 +215,15 @@ namespace bbtk
     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 ) 
@@ -170,6 +232,8 @@ namespace bbtk
 	     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 ) 
@@ -180,10 +244,14 @@ namespace bbtk
 	   std::string type(i->second->GetHumanTypeName());
 	   type += ">";
 	   type.append(1+typelmax-type.size(),' ');
+	   std::string nature(i->second->GetNature());
+	   nature += "]";
+	   nature.append(1+natlmax-nature.size(),' ');
 	   bbtkMessage("Help",1,
-		    "    '"<<name
-		    <<" <"<<type
-		    <<" : "<<i->second->GetDescription()<<std::endl);
+		       "    '"<<name
+		       <<" <"<<type
+		       <<" ["<<nature
+		       <<" : "<<i->second->GetDescription()<<std::endl);
     }
     if (mOutput.size()) 
       bbtkMessage("Help",1," * Outputs : "<<std::endl);
@@ -197,10 +265,14 @@ namespace bbtk
 	   std::string type(o->second->GetHumanTypeName());
 	   type += ">";
 	   type.append(1+typelmax-type.size(),' ');
+	   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);
@@ -208,14 +280,23 @@ namespace bbtk
 
   }
   //=========================================================================
-
+   
+  //=========================================================================
+  /// 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);
+    bbtkDebugMessageInc("Kernel",9,"BlackBoxDescriptor::InsertHtmlHelp() ["<<GetFullTypeName()<<"]"<<std::endl);
     
     //-------------
     // General info 
@@ -232,20 +313,31 @@ namespace bbtk
 
 
     std::string descr = GetDescription();
-    //Utilities::html_format(descr);
+    Utilities::html_format(descr);
     std::string author = GetAuthor();
     Utilities::html_format(author);
 
-    std::string category = GetCategory();
-    Utilities::html_format(category);    
+    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;'>  " 
-      << category << "</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";      
+
     (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";
@@ -301,7 +393,7 @@ namespace bbtk
       Utilities::html_format(type);
       
       std::string descr(in->second->GetDescription());
-      //Utilities::html_format(descr);
+      Utilities::html_format(descr);
       
       std::string out = 
 	"<TR><TD style='vertical-align: top;' bgcolor=\"" + col
@@ -364,7 +456,7 @@ namespace bbtk
 	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