bbtk::Factory Class Reference

Can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded. More...

#include <bbtkFactory.h>

Inheritance diagram for bbtk::Factory:

[legend]

Collaboration diagram for bbtk::Factory:

[legend]

List of all members.

typedef std::map< std::string, Package::Pointer >	PackageMapType
	The type of map of packages.
void	GetPackagesList (std::vector< std::string > &)
	Pushes back the names of the Package s which are in the Factory.
void	LoadPackage (const std::string &name)
	Loads a dynamic library which contains a Package.
void	UnLoadPackage (const std::string &name)
	Unloads a Package which was loaded from a dynamic library.
void	InsertPackage (Package::Pointer)
	Inserts a Package in the Factory.
void	RemovePackage (Package::Pointer)
	Removess a Package from the Factory.
Package::Pointer	GetPackage (const std::string &name) const
	Returns the pointer on a Package provided by name.
const PackageMapType &	GetPackageMap () const
	Returns the map of Packages.
Public Types
enum	IndexEntryType { Packages, Categories, Initials, Adaptors }
typedef Factory	Self
typedef boost::shared_ptr< Self >	Pointer
typedef boost::weak_ptr< Self >	WeakPointer
Public Member Functions
std::string	GetObjectName () const
std::string	GetObjectInfo () const
size_t	GetObjectSize () const
size_t	GetObjectInternalSize () const
size_t	GetObjectRecursiveSize () const
void	WriteDotFilePackagesList (FILE *ff)
void	Reset ()
	Releases all the packages of the Factory.
void	Check () const
void	CreateHtmlIndex (IndexEntryType type, const std::string &filename)
void	SetExecuter (ExecuterPointer e)
	Sets the executer who created the factory (if any).
ExecuterPointer	GetExecuter ()
	Gets the executer who created the factory (if any).
std::string	GetPackageNameOfaBlackBox (std::string boxType)
	Gets the executer who created the factory (if any) - const.
long	GetUseCount ()
void	PrintHelpListPackages (bool details=true, bool adaptors=false) const
	Prints the list of Package.
void	PrintHelpPackage (const std::string &name, bool adaptors=false) const
	Prints help on a particular Package.
void	PrintHelpDescriptor (const std::string &name, std::string &package, bool full=true) const
	Prints help on a BlackBoxDescriptor.
void	ShowGraphTypes (const std::string &name) const
Object creation methods
BlackBox::Pointer	NewBlackBox (const std::string &type, const std::string &name) const
	Creates an instance of a black box of type <type> with name <name>.
BlackBox::Pointer	NewAdaptor (const DataInfo &typein, const DataInfo &typeout, const std::string &name) const
	Creates an instance of a black box of type <type> with name <name>.
BlackBox::Pointer	NewWidgetAdaptor (const DataInfo &typein, const DataInfo &typeout, const std::string &name) const
	Creates an instance of a black box of type <type> with name <name>.
Connection::Pointer	NewConnection (BlackBox::Pointer from, const std::string &output, BlackBox::Pointer to, const std::string &input) const
	Creates an instance of a connection.
Package inspection methods
Allow to test if an Adaptor is present in the packages WITHOUT instanciating it
bool	FindAdaptor (const DataInfo &typein, const DataInfo &typeout, std::string &adaptor) const
	Creates an instance of a black box of type <type> with name <name>.
bool	FindWidgetAdaptor (const DataInfo &typein, const DataInfo &typeout, std::string &adaptor) const
	Creates an instance of a black box of type <type> with name <name>.
bool	FindWidgetAdaptor2 (const DataInfo &typein, const DataInfo &typeout, std::string &widget, std::string &adaptor) const
	Creates an instance of a black box of type <type> with name <name>.
Static Public Member Functions
static Pointer	New ()
	Default ctor.
static void	InsertInObjectList (Pointer)
static void	RemoveFromObjectList (WeakPointer)
static void	InsertInPackageList (Pointer)
static void	ReleasePackages ()
static void	PrintObjectListInfo (const std::string &name)
static void	PrintObjectInfo (const Pointer &o)
static long	GetObjectsCount ()
Protected Types
typedef Object	Superclass
Protected Member Functions
	Factory ()
	Default ctor.
	Factory (const Factory &)
	~Factory ()
	Dtor.
void	LockThis ()
void	UnLockThis ()
template<class U >
boost::shared_ptr< U >	GetThisPointer () const
Static Protected Member Functions
template<class U >
static boost::shared_ptr< U >	MakePointer (U *s, bool lock=false)
template<class U , class D >
static boost::shared_ptr< U >	MakePointer (U *s, const D &del, bool lock=false)
Private Member Functions
bool	DoLoadPackage (std::string libname, std::string pkgname, std::string path)
void	CloseAllPackages ()
void	ClosePackage (PackageMapType::iterator &i)
	Close the package referenced by the iterator.
Private Attributes
PackageMapType	mPackageMap
	The map of packages.
ExecuterWeakPointer	mExecuter
	The executer which created the factory (if any).
Friends
struct	Object::Deleter

---

Detailed Description

Can load and unload dynamic libraries containing black boxes packages and create instances of the black boxes registered in the packages loaded.

Definition at line 53 of file bbtkFactory.h.

---

Member Typedef Documentation

typedef std::map< std::string, Package::Pointer > bbtk::Factory::PackageMapType

The type of map of packages.

Definition at line 75 of file bbtkFactory.h.

typedef boost::shared_ptr<Self> bbtk::Factory::Pointer

Reimplemented from bbtk::Object.

Definition at line 55 of file bbtkFactory.h.

typedef Factory bbtk::Factory::Self

Definition at line 55 of file bbtkFactory.h.

typedef Object bbtk::Factory::Superclass [protected]

Definition at line 55 of file bbtkFactory.h.

typedef boost::weak_ptr<Self> bbtk::Factory::WeakPointer

Reimplemented from bbtk::Object.

Definition at line 55 of file bbtkFactory.h.

---

Member Enumeration Documentation

enum bbtk::Factory::IndexEntryType

Enumerator:

Packages
Categories
Initials
Adaptors

Definition at line 140 of file bbtkFactory.h.

      {
        Packages,
        Categories,
        Initials,
        Adaptors
      }

---

Constructor & Destructor Documentation

bbtk::Factory::Factory

(

)

[protected]

Default ctor.

Definition at line 68 of file bbtkFactory.cxx.

References bbtkDebugMessage.

Referenced by New().

    : mExecuter()
  {
    bbtkDebugMessage("kernel",7,"Factory()"<<std::endl);
  }

Here is the caller graph for this function:

bbtk::Factory::Factory

(

const Factory &

)

[protected]

bbtk::Factory::~Factory

(

)

[protected]

Dtor.

Definition at line 77 of file bbtkFactory.cxx.

References bbtkDebugMessage, and CloseAllPackages().

  {
    bbtkDebugMessage("kernel",7,"==> ~Factory()"<<std::endl);
    CloseAllPackages();
    bbtkDebugMessage("kernel",7,"<== ~Factory()"<<std::endl);
  }

Here is the call graph for this function:

---

Member Function Documentation

void bbtk::Factory::Check

(

)

const

Definition at line 831 of file bbtkFactory.cxx.

References bbtkMessage, and mPackageMap.

  {
    bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this
                 <<std::endl);
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
        i->second->Check();
      }
    bbtkMessage("debug",1,"****** Checking Factory "<<(void*)this
                <<" ... OK"<<std::endl);
  }

void bbtk::Factory::CloseAllPackages

(

)

[private]

Definition at line 349 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessage, bbtkDebugMessageInc, ClosePackage(), bbtk::i, and mPackageMap.

Referenced by Reset(), and ~Factory().

  {
    bbtkDebugMessageInc("kernel",7,"Factory::CloseAllPackages()"<<std::endl);
    
    std::vector< Package::WeakPointer > mAlive;  
    do {
      mAlive.clear();  
      while (mPackageMap.begin() != mPackageMap.end())
        {
          PackageMapType::iterator i = mPackageMap.begin();
          Package::WeakPointer p = i->second;
          ClosePackage(i);
          if (p.lock()) mAlive.push_back(p);
        }
      std::vector< Package::WeakPointer >::iterator i;
      for (i=mAlive.begin();i!=mAlive.end();++i)
        {
          // If not dead : reinsert
          if (i->lock())
            {
              bbtkDebugMessage("kernel",7,"Package "<<i->lock()->GetName()
                               <<" still alive"<<std::endl);
              // InsertPackage(i->lock());
            }
        }      
    }
    while (mPackageMap.size()>0);

    bbtkDebugDecTab("kernel",7);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void bbtk::Factory::ClosePackage

(

PackageMapType::iterator &

i

)

[private]

Close the package referenced by the iterator.

First removes the factory from the set of factories which use the package If the set is empty then : If it is a dynamically loaded package :

• Loads and calls the function "<name>DeletePackage" of the dynamic library (responsible for package desallocation)
• Closes the dynamic library Else :
• deletes the package normally

Finally erases the package entry in the packages map

Definition at line 393 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, mPackageMap, and bbtk::Package::Release().

Referenced by CloseAllPackages(), RemovePackage(), and UnLoadPackage().

  {   
     bbtkDebugMessageInc("kernel",7,"Factory::ClosePackage(\""
                         <<i->second->GetName()
                        <<"\")"<<std::endl);

     
     // Removes this from the set of factories which use the package
     i->second->RemoveFactory(GetThisPointer<Factory>());
     Package::WeakPointer p = i->second;
     // remove the entry in the map
     mPackageMap.erase(i);
     // Release the package if not already destroyed
     if (p.lock()) 
       {
         Package::Release(p);
       }
     bbtkDebugDecTab("kernel",7);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void bbtk::Factory::CreateHtmlIndex	(	IndexEntryType	type,
		const std::string &	filename
	)

Definition at line 919 of file bbtkFactory.cxx.

References Adaptors, bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, bbtkError, Categories, bbtk::ConfigurationFile::Get_bin_path(), bbtk::ConfigurationFile::GetInstance(), bbtk::Utilities::html_format(), Initials, mPackageMap, Packages, bbtk::Utilities::SplitString(), and bbtk::BlackBoxDescriptor::STANDARD.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::CreateHtmlIndex(\""
                        <<filename<<"\")"<<bbtkendl);
    
    std::string title;

    typedef std::map<std::string, 
                     std::vector<BlackBoxDescriptor::Pointer> > IndexType;
    IndexType index;
    // Builds the index map
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
        {
                Package::Pointer pack = i->second;
                if (pack->GetName()=="user") continue;
                Package::DescriptorMapType::const_iterator j;
                for (j = pack->GetDescriptorMap().begin(); 
                        j!= pack->GetDescriptorMap().end(); 
                        ++j)
                {
            
            // Skip adaptors 
                        if ( type==Adaptors )
                        {  
                                if (j->second->GetKind() == BlackBoxDescriptor::STANDARD )
                                continue;
                        }
                        else 
                                if (j->second->GetKind() != BlackBoxDescriptor::STANDARD )
                                continue;

                        std::vector<std::string> keys;
                        if (type==Packages)
                        {
                                std::string k("");
                                k += pack->GetName();
                                keys.push_back(k);
                                title = "Boxes by package";
                        }
                        else if ((type==Initials) || (type==Adaptors))
                        {
                                std::string init(" ");
                                init[0] =  std::toupper(j->second->GetTypeName()[0]);
                                keys.push_back(init);
                                title = "Alphabetical list";
                        }
                        else if (type==Categories)
                        {
                        // Split the category string 
                        std::string delimiters = ";,";
                        Utilities::SplitString(j->second->GetCategory(),
                                           delimiters,keys);
                        if (keys.size()==0) 
                                keys.push_back(" NONE");
                                title = "Boxes by category";
                        }

                        std::vector<std::string>::const_iterator k;
                        for (k=keys.begin(); k!=keys.end(); ++k )
                        {
                                IndexType::iterator p;
                                p = index.find(*k);
                                if (p != index.end()) 
                                {
                                        p->second.push_back(j->second);
                                }
                                else 
                                {
                                        std::vector<BlackBoxDescriptor::Pointer> v;
                                        v.push_back(j->second);
                                        index[*k] = v;
                                }
                        }
                }
        }   
    // Creates the file 
    //---------------------
    // Open output file
    std::ofstream s;
    s.open(filename.c_str());
    if (!s.good()) 
    {
       bbtkError("Factory::CreateHtmlIndex : could not open file '"
                 <<filename<<"'");
    }
    
    //----------------------
    // Html head
    s << "<html lang=\"en\">\n";
    s << "<head>\n";
    s << "<title>"<<title<<"</title>\n";
    s << "<meta http-equiv=\"Content-Type\" content=\"text/html\">\n";
    s << "<meta name=\"description\" content=\""<<title<<"\">\n";
    s << "<meta name=\"generator\" content=\"\">\n";
    s << "<link title=\"Top\" rel=\"top\" href=\"#Top\">\n";
    //<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
    s << "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\"><style type=\"text/css\"><!--\n";
    s << "pre.display { font-family:inherit }\n";
    s << "pre.format  { font-family:inherit }\n";
    s << "pre.smalldisplay { font-family:inherit; font-size:smaller }\n";
    s << "pre.smallformat  { font-family:inherit; font-size:smaller }\n";
    s << "pre.smallexample { font-size:smaller }\n";
    s << "pre.smalllisp    { font-size:smaller }\n";
    s << "span.sc    { font-variant:small-caps }\n";
    s << "span.roman { font-family:serif; font-weight:normal; } \n";
    s << "span.sansserif { font-family:sans-serif; font-weight:normal; }\n"; 
    s << "--></style>\n";
    s << "</head>\n";
    //----------------------

    //----------------------
    // Html body
    s << "<body>\n";
    s << "<a name=\"Top\"></a>\n"; 
    s << "<h1 class=\"settitle\">"<<title<<"</h1>\n";
    s << "<p>\n";
    IndexType::iterator ii;
    for (ii=index.begin();ii!=index.end();++ii)
      {
                s << "<a href=\"#"<<ii->first<<"\">"<<ii->first<<"</a>&nbsp;&nbsp;";    
      }

    for (ii=index.begin();ii!=index.end();++ii)
      {
        s << "<p><hr>\n";
        s << "<p><a href=\"#Top\">Top</a>";
        if (type==Packages)
          {
            s << "<a name=\""<<ii->first<<"\"></a>\n"; 
            s << "<p><a href=\""<<ii->first<<"/index.html\">"
              << ii->first<<"</a>\n"; 

            s << "&nbsp;&nbsp;-&nbsp;&nbsp;\n"; 

            s << "<a name=\"doxygen\"></a>\n"; 

//EED 26Mars2009
        /*JCP 19 Nov 2009
                std::string bin_path = bbtk::ConfigurationFile::GetInstance().Get_bin_path();
            s << "<a href=" << bin_path <<"/../share/bbtk/doc/doxygen/" << ii->first << "/main.html>(Doxygen documentation of the source)</a>\n"; 
        JCP 19 Nov 2009*/
                std::string bin_path = bbtk::ConfigurationFile::GetInstance().Get_bin_path();           
            s << "<a href=" << bin_path <<"/../share/bbtk/doc/doxygen/" << ii->first << "/main.html>(Doxygen documentation of the source)</a>\n"; 
          }
        else 
          {
            s << "<a name=\""<<ii->first<<"\"></a>\n"; 
            s << "<p><b>"<<ii->first<<"</b>\n";
          }
        s << "<ul>\n";

        s << "<p><TABLE cellspacing=0  cellpadding=3>\n";

        std::vector<BlackBoxDescriptor::Pointer>::iterator di;
        for (di=ii->second.begin();di!=ii->second.end();++di)
          {
            std::string pack = (*di)->GetPackage()->GetName();
            std::string name = (*di)->GetTypeName();
            Utilities::html_format(name);
            std::string descr = (*di)->GetDescription();
            Utilities::html_format(descr);
            s << "<TR>";
            s << "<TD style='vertical-align: top;'>";
            s << "&nbsp;&nbsp;&nbsp;<a href=\""<<pack
              <<"/index.html#"<<name<<"\">"
              <<pack<<"::"<<name<<"</a>";
            s << "</TD> ";
            s << " <TD style='vertical-align: top;'>" << descr << " </TD>";
            s << "</TR>\n";
          }    
        s << "</TABLE>\n";
        s << "</ul>\n";
        s << "</div>\n";
      }
    //----------------------
    // Footer 
    time_t rawtime;
    tm * ptm;
    time ( &rawtime );
    ptm = gmtime ( &rawtime );

    s << "<p><hr>\n";
    s << "Automatically generated by <b>bbtk</b> on "
      << ptm->tm_mday << "/" << ptm->tm_mon << "/" << ptm->tm_year+1900 
      << " - " << ptm->tm_hour << ":" << ptm->tm_min << " GMT\n";
    s << "</body></html>\n"; 
    s.close();
    //----------------------

    // End
    bbtkDebugDecTab("kernel",9);
  }

Here is the call graph for this function:

bool bbtk::Factory::DoLoadPackage	(	std::string	libname,
		std::string	pkgname,
		std::string	path
	)			[private]

Definition at line 98 of file bbtkFactory.cxx.

References bbtkMessage, bbtk::Package::CreateFromDynamicLibrary(), and mPackageMap.

Referenced by LoadPackage().

  {
    
    Package::Pointer p = Package::CreateFromDynamicLibrary(libname,
                                                           pkgname,
                                                           path);
    if (p!=0)
      {
        //===================================================================
        bbtkMessage("output",2,p->GetName()<<" "
                    <<p->GetVersion()
                    <<" "
                    <<p->GetAuthor() << " Category(s) :"
                    <<p->GetCategory()
                    <<std::endl);
        bbtkMessage("output",2,p->GetDescription()<<std::endl);
        //===================================================================
        p->AddFactory(GetThisPointer<Factory>());
printf("EED Factory::DoLoadPackage > %s %s  %s \n",libname.c_str(), pkgname.c_str(),path.c_str());                
        mPackageMap[pkgname] = p;
        return true;
      }
    return false;
    
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool bbtk::Factory::FindAdaptor	(	const DataInfo &	typein,
		const DataInfo &	typeout,
		std::string &	adaptor
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 664 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, and mPackageMap.

Referenced by FindWidgetAdaptor2().

  {
    bbtkDebugMessageInc("kernel",8,"Factory::FindAdaptor(<"
                        <<typein<<">,<"
                        <<typeout<<">)"<<bbtkendl);
    
    bool b = false;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
        b = i->second->FindAdaptor(typein,
                                            typeout,
                                            adaptor);
        if (b) break; 
      }
    /*
    if (!b) 
      {
        bbtkError("no "<<typein<<" to "<<typeout
                  <<"> widget adaptor available");
      } 
    */

    bbtkDebugDecTab("kernel",7);
    return b; 
  }

Here is the caller graph for this function:

bool bbtk::Factory::FindWidgetAdaptor	(	const DataInfo &	typein,
		const DataInfo &	typeout,
		std::string &	adaptor
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 696 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",8,"Factory::FindWidgetAdaptor(<"
                        <<typein<<">,<"
                        <<typeout<<">)"<<bbtkendl);
    
    bool b = false;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
        b = i->second->FindWidgetAdaptor(typein,
                                                  typeout,
                                                  adaptor);
        if (b) break; 
      }
    bbtkDebugDecTab("kernel",7);
    return b; 
  }

bool bbtk::Factory::FindWidgetAdaptor2	(	const DataInfo &	typein,
		const DataInfo &	typeout,
		std::string &	widget,
		std::string &	adaptor
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 720 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, bbtkMessage, bbtk::BlackBoxDescriptor::DEFAULT_GUI, FindAdaptor(), bbtk::DataInfo::GetNature(), bbtk::DataInfo::GetType(), and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",8,"Factory::FindWidgetAdaptor(<"
                        <<typein<<">,<"
                        <<typeout<<">)"<<bbtkendl);
    
    bool b = false;
    adaptor = widget = "";
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
        b = i->second->FindWidgetAdaptor(typein,
                                                  typeout,
                                                  widget);
        if (b) break; 
      }
    if (!b) 
      {
        // Look for a widget adaptor with good nature out
        bbtkMessage("kernel",5,
                    "*** Looking for a two pieces widget adaptor for : "
                    << typein << "->"<<typeout<<std::endl);
        for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
          {
            Package::AdaptorMapType::const_iterator j;
            for (j=i->second->GetAdaptorMap().begin();
                 j!=i->second->GetAdaptorMap().end();
                 ++j)
              {
                if ( ( j->first.mKind ==  
                       BlackBoxDescriptor::DEFAULT_GUI) &&
                     //(j->first.mTypeIn == typein) &&
                     (j->first.mTypeOut.GetNature() == typeout.GetNature() ) 
                     )
                  {
                    widget = j->second.lock()->GetTypeName();
                    bbtkMessage("kernel",5,
                                "===> Found first part : "<<widget
                                << " "<<j->first.mTypeIn<<"->"
                                <<j->first.mTypeOut<<std::endl);
                    DataInfo ti( j->first.mTypeOut.GetType(), "");
                    DataInfo to( typeout.GetType(), "");
                    b = FindAdaptor( ti, to, adaptor );
                    if (b) 
                      {
                        bbtkMessage("kernel",5,
                                    "===> Found second part : "<<adaptor
                                    <<std::endl);
                        break;
                      }
                    else
                      {
                        bbtkMessage("kernel",5,
                                    "===> No second part found"<<std::endl);
                      }
                  }
              }
            if (b) break;
          }
      }
    bbtkDebugDecTab("kernel",7);
    return b; 
  }

Here is the call graph for this function:

ExecuterPointer bbtk::Factory::GetExecuter

(

)

[inline]

Gets the executer who created the factory (if any).

Definition at line 153 of file bbtkFactory.h.

{ return mExecuter.lock(); }

std::string bbtk::Factory::GetObjectInfo

(

)

const [virtual]

Reimplemented from bbtk::Object.

Definition at line 1122 of file bbtkFactory.cxx.

  {
    std::stringstream i;
    return i.str();
  }

size_t bbtk::Factory::GetObjectInternalSize

(

)

const [virtual]

Reimplemented from bbtk::Object.

Definition at line 1138 of file bbtkFactory.cxx.

Referenced by GetObjectRecursiveSize(), and GetObjectSize().

{
  size_t s = sizeof(Factory);
  return s;
  }

Here is the caller graph for this function:

std::string bbtk::Factory::GetObjectName

(

)

const [virtual]

Reimplemented from bbtk::Object.

Definition at line 1115 of file bbtkFactory.cxx.

  {
    return std::string("Factory");
  }

size_t bbtk::Factory::GetObjectRecursiveSize

(

)

const [virtual]

Reimplemented from bbtk::Object.

Definition at line 1145 of file bbtkFactory.cxx.

References GetObjectInternalSize(), bbtk::Object::GetObjectRecursiveSize(), and mPackageMap.

  {
    size_t s = Superclass::GetObjectRecursiveSize();
    s += Factory::GetObjectInternalSize();

    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
    {
      s += i->second->GetObjectRecursiveSize();
    }
    return s;
  }

Here is the call graph for this function:

static long bbtk::Object::GetObjectsCount

(

)

[inline, static, inherited]

Definition at line 75 of file bbtkObject.h.

Referenced by bbtk::StaticInitTime::~StaticInitTime().

{ return mgObjectList.size(); }

Here is the caller graph for this function:

size_t bbtk::Factory::GetObjectSize

(

)

const [virtual]

Reimplemented from bbtk::Object.

Definition at line 1130 of file bbtkFactory.cxx.

References GetObjectInternalSize(), and bbtk::Object::GetObjectSize().

{
  size_t s = Superclass::GetObjectSize();
  s += Factory::GetObjectInternalSize();
  return s;
  }

Here is the call graph for this function:

Package::Pointer bbtk::Factory::GetPackage

(

const std::string &

name

)

const

Returns the pointer on a Package provided by name.

Definition at line 808 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkError, and mPackageMap.

Referenced by WriteDotFilePackagesList().

  {
    bbtkDebugMessageInc("kernel",9,"Factory::GetPackage(\""<<name<<"\")"
                         <<std::endl);

    PackageMapType::const_iterator i = mPackageMap.find(name);
    if ( i != mPackageMap.end() ) 
    {
      bbtkDebugDecTab("kernel",9); 
      return i->second;
    }
    else 
    {
       bbtkDebugDecTab("kernel",9);
       bbtkError("package \""<<name<<"\" unknown");
    }
    
    bbtkDebugDecTab("kernel",9);  
  }

Here is the caller graph for this function:

const PackageMapType& bbtk::Factory::GetPackageMap

(

)

const [inline]

Returns the map of Packages.

Definition at line 77 of file bbtkFactory.h.

{ return mPackageMap; }

std::string bbtk::Factory::GetPackageNameOfaBlackBox

(

std::string

boxType

)

Gets the executer who created the factory (if any) - const.

Definition at line 559 of file bbtkFactory.cxx.

References mPackageMap.

        {
                std::string result="<void bbtk package name>";
                PackageMapType::const_iterator i;
                for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
                {
                        if ( i->second->ifBoxExist( boxType ) == true)
                        {
                                result = i->first;
                        }
                }
                return result;
        }

void bbtk::Factory::GetPackagesList

(

std::vector< std::string > &

)

Pushes back the names of the Package s which are in the Factory.

template<class U >

boost::shared_ptr<U> bbtk::Object::GetThisPointer

(

)

const [inline, protected, inherited]

Definition at line 92 of file bbtkObject.h.

    {
      return boost::dynamic_pointer_cast<U>(mThisPointer.lock());
    }

long bbtk::Object::GetUseCount

(

)

[inline, inherited]

Definition at line 63 of file bbtkObject.h.

{ return mThisPointer.use_count(); }

void bbtk::Object::InsertInObjectList

(

Pointer

p

)

[static, inherited]

Definition at line 59 of file bbtkObject.cxx.

References bbtkDebugMessage, and bbtk::Object::mgObjectList.

Referenced by bbtk::Object::MakePointer().

  { 
    bbtkDebugMessage("object",9,"##> Object::InsertInObjectList(\""
                     <<p->GetObjectName()<<"\" ["<<p<<"])"<<std::endl);
    boost::weak_ptr<Object> w(p);
    mgObjectList.insert(w); 
  }

Here is the caller graph for this function:

void bbtk::Object::InsertInPackageList

(

Pointer

p

)

[static, inherited]

Definition at line 69 of file bbtkObject.cxx.

References bbtkDebugMessage, and bbtk::Object::mgPackageList.

  { 
    bbtkDebugMessage("object",9,"##> Object::InsertInPackageList(\""
                     <<p->GetObjectName()<<"\" ["<<p<<"])"<<std::endl);
    boost::weak_ptr<Object> w(p);
    mgPackageList.insert(w); 
  }

void bbtk::Factory::InsertPackage

(

Package::Pointer

p

)

Inserts a Package in the Factory.

Inserts a package in the factory.

Definition at line 515 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::InsertPackage(\""<<
                        p->GetName()<<"\")"<<std::endl);

    p->AddFactory(GetThisPointer<Factory>());
          
printf("EED Factory::InsertPackage %s\n", p->GetName().c_str() );         
          
    mPackageMap[p->GetName()] = p;

    bbtkDebugDecTab("kernel",9);
  }

void bbtk::Factory::LoadPackage

(

const std::string &

name

)

Loads a dynamic library which contains a Package.

Loads a package.

The name is the system-independant name of the package (the name of the instance of bbtk::Package). Tries to open the dynamic library :

• "libbb<name>.so" for linux systems,
• "bb<name>.dll" for windows systems. If it succeeds, then tries to load the symbols "<name>GetPackage" and "<name>DeletePackage". "<name>GetPackage" is called to get the pointer on the bbtk::Package of the library ("<name>DeletePackage" is not used, its presence is just checked before loading the package). now, filename is only the last name (no longer the full name!) it will be searched within *all* the paths given in bbtk_config.xml

Definition at line 142 of file bbtkFactory.cxx.

References bbtkDebugMessageInc, bbtkError, bbtkMessage, DoLoadPackage(), bbtk::Utilities::ExpandLibName(), bbtk::Utilities::ExtractPackageName(), bbtk::Utilities::FileExists(), bbtk::ConfigurationFile::Get_package_paths(), bbtk::ConfigurationFile::GetInstance(), bbtk::i, bbtk::Utilities::MakeLibnameFromPath(), and mPackageMap.

  {
          
          
  // Note : in the following :
  // name : the user supplied name
  //      - abreviated name    e.g.       pkg   pkg.so   libbpkg   libbbpkg.so
  //      - relative full name e.g.       ./libbbpkg.so   ../../libbbpkg.so
  //      - absolute full name e.g.       /home/usrname/proj/lib/libbbpkg.so
  //          same for Windows, with      c:, d: ...
  //
  // lastname : string before the last / (if any), or user supplied name
          
         
          
        if(name != ""){
                bbtkDebugMessageInc("kernel",7,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);
                bbtkMessage("debug",1,"Factory::LoadPackage(\""<<name<<"\")"<<std::endl);

                std::vector<std::string> package_paths;
                std::string libname;  // full path library name
                std::string pkgname;  // e.g. libbb<pkgname>.so

                std::string upath;

                
                pkgname = Utilities::ExtractPackageName(name,upath);
                
                printf("EED Factory::LoadPackage A. %s\n", name.c_str());
                printf("EED Factory::LoadPackage A. %s\n", upath.c_str());
                printf("EED Factory::LoadPackage A. %s\n", pkgname.c_str());
                
                bbtkMessage("debug",1,"Package name ["<<pkgname<<"]"<<std::endl);
                bbtkMessage("debug",1,"Package path ["<<upath<<"]"<<std::endl);

                // no loading package if already loaded
                PackageMapType::iterator iUnload;
                iUnload = mPackageMap.find(pkgname);
                
                PackageMapType::iterator it;
std::cout << "EED Factory::LoadPackage PackageMap ";
                for ( it=mPackageMap.begin() ; it != mPackageMap.end(); it++ )
                        std::cout << (*it).first << " ";
                std::cout << std::endl;

                if (iUnload != mPackageMap.end())
                {
                  bbtkMessage("output",2,"["<< pkgname <<"] already loaded" << std::endl);
                  return;
                }

        // =================================================
        // The following structure was checked to work
        // with any type of relative/absolute path.
        // Please don't modify it without checking
        // *all* the cases. JP
        //==================================================

                printf("\nEED Factory::LoadPackage B. %s\n\n", name.c_str());
        //std::cout << "upath [" << name << "]" << std::endl;

                bool ok = false;
                bool foundFile = false;

                // If path provided by user will be the first scanned :
                // push it into vector of paths
                if (upath.length()>0)   // ------------------------------------- check user supplied location
                {
                   if (name[0] != '.' && name[0] != '/' && name[1]!= ':')
                   {
                          bbtkError("Use absolute or relative path name! ["<<name<<"] is an illegal name");
                          return;
                   }

                  // std::string path = Utilities::ExpandLibName(upath, false);

                   std::string path = Utilities::ExpandLibName(name,false); // keep last item, here.
                   if (path != "")
                   {
                          std::string p2;
                          Utilities::ExtractPackageName(path,p2);
                          //libname = Utilities::MakeLibnameFromPath(path, pkgname);
                          libname = Utilities::MakeLibnameFromPath(p2, pkgname); // remove last item
                          // Check if library exists
                          if ( !Utilities::FileExists(libname) )
                          {
                          // The following is *NOT* a debug time message :
                          // It's a user intended message.
                          // Please don't remove it.
                        bbtkMessage("output",3,"   [" <<libname 
                                <<"] : doesn't exist" <<std::endl);
                          }
                          else
                          {
                                 ok = DoLoadPackage( libname, pkgname, path);         
                          }
                   }
                   else
                   {
                          bbtkError("Path ["<<upath<<"] doesn't exist");
                          return;
                   }
                }
                else     // ----------------------------------------------------- iterate on the paths  
                {

                std::string path = ".";
                package_paths = ConfigurationFile::GetInstance().Get_package_paths();
                std::vector<std::string>::iterator i;
                for (i=package_paths.begin();i!=package_paths.end();++i)
                {
                        foundFile = false;
                        path = *i;
//std::cout<<"JCP bbtkFactory.cxx void Factory::LoadPackage = path "<<path<<std::endl;
                        // we *really* want '.' to be the current working directory
                        if (path == ".")
                        {
                          char buf[2048]; // for getcwd
                          char * currentDir = getcwd(buf, 2048);
                          std::string cwd(currentDir);
//std::cout<<"JCP  bbtkFactory.cxx void Factory::LoadPackage = currentDir "<<currentDir<<std::endl;
                          path = currentDir;
                        }
//std::cout<<"JCP bbtkFactory.cxx void Factory::LoadPackage = path "<<path<<" pkgnam="<<pkgname<<std::endl;              
                        libname = Utilities::MakeLibnameFromPath(path, pkgname);

                        bbtkMessage("debug",2,"-> Trying to load [" << libname << "]" <<std::endl);

                  // Check if library exists           
                        if ( !Utilities::FileExists(libname) )
                        {
                        // The following is *NOT* a debug time message :
                        // It's a user intended message.
                        // Please don't remove it.
                          bbtkMessage("output",3,
                                  "   [" <<libname <<"] : doesn't exist" <<std::endl);
                           continue;  // try next path
                        }
                        foundFile = true; 

                  // Try to Load the library

                        ok = DoLoadPackage( libname, pkgname, path);
                        if (ok)
                        {
                           bbtkMessage("debug",2,"   OK"<<std::endl);
                        }
                break; // we stop iterating even if error : have to signal it to user
                } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )

        }

                if( !ok )  // nothing was loaded
                {
                  if (!foundFile)
                  {
                        bbtkError("Could not find package ["<<pkgname<< "]");
                  }
                  else
                  {
        #if defined(__GNUC__)
                        bbtkError("Could not load package ["<< pkgname
                                          <<"] :" << std::endl 
                          << "  Opening "<<libname<<" failed"
                          << "  Reason: "<< dlerror());
        #elif defined(_WIN32)
                        bbtkError("Could not load package ["<<pkgname
                          <<"] :"<< std::endl << "   Error loading " <<libname);

                // look how to get the error message on win
                //<<dlerror());
                // it is the bordel !! (the bloody fucking bordel, you mean?)
                // look : http://msdn2.microsoft.com/en-us/library/ms680582.aspx
        #endif
                  }
                }       
                bbtkMessage("output",2,"[" << libname << "] loaded" << std::endl);
        }

    

  }

Here is the call graph for this function:

void bbtk::Object::LockThis

(

)

[inline, protected, inherited]

Definition at line 88 of file bbtkObject.h.

{ mThisPointerLocked = mThisPointer.lock(); }   

template<class U , class D >

static boost::shared_ptr<U> bbtk::Object::MakePointer	(	U *	s,
		const D &	del,
		bool	lock = false
	)			[inline, static, protected, inherited]

Definition at line 115 of file bbtkObject.h.

References bbtk::Object::InsertInObjectList().

    {                                                                   
      if (s->mThisPointer.lock())                                       
        {                                                               
          boost::shared_ptr<U> p = s->GetThisPointer<U>();
          if (!lock) s->mThisPointerLocked.reset();
          return p;
        }                                                               
      boost::shared_ptr<U> p = boost::shared_ptr<U>(s,del);
      static_cast<D*>                                   
        (p._internal_get_deleter(typeid(D)))            
        ->mPointer = p;                                                 
      s->mThisPointer = p;                                              
      Object::InsertInObjectList(p);                                    
      if (lock) s->LockThis();                                          
      return p;                                                 
    }                                                                   

Here is the call graph for this function:

template<class U >

static boost::shared_ptr<U> bbtk::Object::MakePointer	(	U *	s,
		bool	lock = false
	)			[inline, static, protected, inherited]

Definition at line 97 of file bbtkObject.h.

References bbtk::Object::InsertInObjectList().

Referenced by bbtk::ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(), bbtk::Executer::Executer(), bbtk::Interpreter::Init(), bbtk::Transcriptor::New(), bbtk::Package::New(), bbtk::InterpreterVirtual::New(), bbtk::Interpreter::New(), New(), bbtk::Executer::New(), and bbtk::ComplexBlackBoxDescriptor::New().

    {                                                                   
      if (s->mThisPointer.lock())                                       
        {                                                               
          boost::shared_ptr<U> p = s->GetThisPointer<U>();
          if (!lock) s->mThisPointerLocked.reset();
          return p;
        }                                                               
      boost::shared_ptr<U> p = boost::shared_ptr<U>(s,Object::Deleter());
      static_cast<Object::Deleter*>                                     
        (p._internal_get_deleter(typeid(Object::Deleter)))              
        ->mPointer = p;                                                 
      s->mThisPointer = p;                                              
      Object::InsertInObjectList(p);                                    
      if (lock) s->LockThis();                                          
      return p;                                                 
    }                                                                   

Here is the call graph for this function:

Here is the caller graph for this function:

Factory::Pointer bbtk::Factory::New

(

)

[static]

Default ctor.

Definition at line 59 of file bbtkFactory.cxx.

References bbtkDebugMessage, Factory(), and bbtk::Object::MakePointer().

Referenced by NewConnection().

  {
    bbtkDebugMessage("kernel",9,"Factory::New()"<<std::endl);
    return MakePointer(new Factory());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

BlackBox::Pointer bbtk::Factory::NewAdaptor	(	const DataInfo &	typein,
		const DataInfo &	typeout,
		const std::string &	name
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 601 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, bbtkError, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",8,"Factory::NewAdaptor("
                        <<typein<<","
                        <<typeout<<",\""
                        <<name<<"\")"<<bbtkendl);


    BlackBox::Pointer b; 
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      b = i->second->NewAdaptor(typein,typeout,name);
      if (b) break; 
      }
    if (!b) 
      {
        bbtkError("no "<<typein<<" to "<<typeout
                  <<" adaptor available");
      } 
    
    bbtkDebugDecTab("kernel",7);
    return b; 
  }

BlackBox::Pointer bbtk::Factory::NewBlackBox	(	const std::string &	type,
		const std::string &	name
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 576 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkError, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",7,"Factory::NewBlackBox(\""
                        <<type<<"\",\""<<name<<"\")"<<std::endl);

    BlackBox::Pointer b; 
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      b = i->second->NewBlackBox(type,name);
      if (b) break; 
      }
    if (!b) 
      {
       bbtkError("black box type \""<<type<<"\" unknown");
      } 

    bbtkDebugDecTab("kernel",7);
    return b;
  }

Connection::Pointer bbtk::Factory::NewConnection	(	BlackBox::Pointer	from,
		const std::string &	output,
		BlackBox::Pointer	to,
		const std::string &	input
	)			const

Creates an instance of a connection.

Definition at line 790 of file bbtkFactory.cxx.

References bbtkDebugMessage, and New().

  {
    bbtkDebugMessage("kernel",7,"Factory::NewConnection(\""
                      <<from->bbGetName()<<"\",\""<<output<<"\",\""
                      <<to->bbGetName()<<"\",\""<<input
                      <<"\")"<<std::endl);
    
    return Connection::New(from,output,to,input,
                           GetThisPointer<Factory>());
  }

Here is the call graph for this function:

BlackBox::Pointer bbtk::Factory::NewWidgetAdaptor	(	const DataInfo &	typein,
		const DataInfo &	typeout,
		const std::string &	name
	)			const

Creates an instance of a black box of type <type> with name <name>.

Definition at line 632 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkendl, bbtkError, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",8,"Factory::NewWidgetAdaptor(<"
                        <<typein<<">,<"
                        <<typeout<<">,\""
                        <<name<<"\")"<<bbtkendl);


    BlackBox::Pointer b; 
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
        b = i->second->NewWidgetAdaptor(typein,
                                                 typeout,
                                                 name);
      if (b) break; 
      }
    if (!b) 
      {
        bbtkError("no "<<typein<<" to "<<typeout
                  <<"> widget adaptor available");
      } 
    
    bbtkDebugDecTab("kernel",7);
    return b; 
  }

void bbtk::Factory::PrintHelpDescriptor	(	const std::string &	name,
		std::string &	package,
		bool	full = true
	)			const

Prints help on a BlackBoxDescriptor.

Prints help on the black box of type <name> Returns the package to which it belongs

Definition at line 483 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkError, bbtk::i, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::PrintHelpDescriptor(\""
                        <<name<<"\")"
                        <<std::endl);

    bool found = false;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
      if (i->second->ContainsDescriptor(name)) 
        {
          i->second->PrintHelpDescriptor(name,full);
              package = i->second->GetName();
          found = true;
        }
      }
    
    bbtkDebugDecTab("kernel",9);
    if (!found) 
      {
      bbtkError("No package of the factory contains any black box <"
                 <<name<<">");
      }
  }  

void bbtk::Factory::PrintHelpListPackages	(	bool	details = true,
		bool	adaptors = false
	)			const

Prints the list of Package.

Definition at line 417 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkMessage, bbtk::i, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::PrintPackages"<<std::endl);

    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
    {
      bbtkMessage("help",1, i->first << std::endl);
      if (details) {
         i->second->PrintHelpListDescriptors(false,adaptors);
      }
    }

    bbtkDebugDecTab("kernel",9);
  }

void bbtk::Factory::PrintHelpPackage	(	const std::string &	name,
		bool	adaptors = false
	)			const

Prints help on a particular Package.

Displays help on a package.

Definition at line 436 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkDecTab, bbtkError, bbtkIncTab, bbtkMessage, bbtkMessageCont, bbtk::i, and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::PrintHelpPackage(\""
                        <<name<<"\")"
                        <<std::endl);

    PackageMapType::const_iterator i = mPackageMap.find(name);
    if ( i != mPackageMap.end() ) 
      {
      bbtkMessage("help",1, "Package "<<i->first<<" ");
      
      if (i->second->GetVersion().length()>0)
        bbtkMessageCont("help",1,"v" <<i->second->GetVersion());
        
      if (i->second->GetAuthor().length()>0)
        bbtkMessageCont("help",1,"- "<<i->second->GetAuthor());
        
      if (i->second->GetCategory().length()>0)
        bbtkMessageCont("help",1,"- "<<i->second->GetCategory());        
        
      bbtkMessageCont("help",1,std::endl);
      bbtkIncTab("help",1);
      bbtkMessage("help",1,i->second->GetDescription()<<std::endl);
      if (i->second->GetNumberOfDescriptors()>0) 
        {
          bbtkMessage("help",1, "Black boxes : "<<std::endl);
          i->second->PrintHelpListDescriptors(true,adaptors);
        }
      else 
        {
          bbtkMessage("help",1, "No black boxes"<<std::endl);
        }
      bbtkDecTab("help",1);
      }
    else 
      {
      bbtkDebugDecTab("kernel",9);
      bbtkError("package \""<<name<<"\" unknown");
      }
    
    bbtkDebugDecTab("kernel",9);
  }

void bbtk::Object::PrintObjectInfo

(

const Pointer &

o

)

[static, inherited]

Definition at line 180 of file bbtkObject.cxx.

Referenced by bbtk::Object::PrintObjectListInfo().

  {
    std::cout << "* [" << p << "] \t" 
              << p.use_count()-1 << " r \t"
              << p->GetObjectRecursiveSize() << " ("
              << p->GetObjectSize() << ") b \t"
              << p->GetObjectName() 
              << std::endl;
    std::cout << p->GetObjectInfo();
  }

Here is the caller graph for this function:

void bbtk::Object::PrintObjectListInfo

(

const std::string &

name

)

[static, inherited]

Definition at line 105 of file bbtkObject.cxx.

References bbtk::i, bbtk::Object::mgObjectList, and bbtk::Object::PrintObjectInfo().

Referenced by bbtk::Interpreter::commandDebug().

  {
    
    std::cout 
      << "=============== Living bbtk::Object pointers ========="<<std::endl;

    long n = 0;
    long u = 0;
    size_t m = 0;
    ObjectListType::iterator i;
    for (i = mgObjectList.begin();
         i!=mgObjectList.end();
         ++i)
      {
        if (i->use_count() == 0) 
          {
            u++;
          }
        else 
          { 
            Object::Pointer p(i->lock());
            if (p->GetObjectName().find(name) != std::string::npos ) 
              {
                std::cout << n << "/" << mgObjectList.size() << " ";
                PrintObjectInfo(p);
                m += p->GetObjectSize();
                n++;
              }
          }
      }
    std::cout 
      << "------------------------------------------------------"<<std::endl; 

    std::cout << " Total : "<<n<<" objects - "<<m<<" b"<<std::endl;
    if (u==1)
      {
        std::cout<<"* Note : "<<u
                 <<" object in list has 0 ref count, "
                 <<"i.e. are no more accessible by bbtk but did not properly destroyed because another ref counting system is holding them !"<<std::endl;
      }
    else if (u>1)
      {
        std::cout<<"* Note : "<<u
                 <<" objects in list have 0 ref count, "
                 <<"i.e. are no more accessible by bbtk but did not properly destroyed because another ref counting system is holding them !"<<std::endl;
      }
    std::cout
      << "============ EO Living bbtk::Object pointers ========="<<std::endl;
        
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void bbtk::Object::ReleasePackages

(

)

[static, inherited]

Definition at line 222 of file bbtkObject.cxx.

References bbtkDebugMessage, bbtk::i, bbtk::Object::mgPackageList, and bbtk::Package::Release().

Referenced by bbtk::StaticInitTime::~StaticInitTime().

  {
    bbtkDebugMessage("object",1,"##> Object::ReleasePackages()"<<std::endl);
    // Release package pointers
    ObjectListType::iterator i;
    for (i = mgPackageList.begin();
         i!= mgPackageList.end();
         ++i)
      {
        if (i->use_count() != 0) 
          { 
            bbtkDebugMessage("object",1,"##> Releasing package '"<<
                             i->lock()->GetThisPointer<Package>()->GetName()
                             <<"'"<<std::endl);
            //      Object::Pointer p(i->lock());
            Package::WeakPointer w(i->lock()->GetThisPointer<Package>());
            Package::Release(w);
            /*
            if (p->GetObjectName().find(name) != std::string::npos ) 
              {
                std::cout << n << "/" << mgObjectList.size() << " ";
                PrintObjectInfo(p);
                m += p->GetObjectSize();
                n++;
              }
            */
          }
      }  

  }

Here is the call graph for this function:

Here is the caller graph for this function:

void bbtk::Object::RemoveFromObjectList

(

WeakPointer

p

)

[static, inherited]

Definition at line 80 of file bbtkObject.cxx.

References bbtkDebugMessage, and bbtk::Object::mgObjectList.

Referenced by bbtk::Object::Deleter::operator()().

  { 
    bbtkDebugMessage("object",9,"##> Object::RemoveFromObjectList()"
                     <<std::endl);
    mgObjectList.erase(p);

  }

Here is the caller graph for this function:

void bbtk::Factory::RemovePackage

(

Package::Pointer

p

)

Removess a Package from the Factory.

Removes a package from the factory (and deletes it).

Definition at line 532 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkError, ClosePackage(), and mPackageMap.

  {
    bbtkDebugMessageInc("kernel",9,"Factory::RemovePackage(\""<<
                        p->GetName()<<"\")"<<std::endl);

    PackageMapType::iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
      {
         if (i->second == p) break;
      };
    
    if (i!=mPackageMap.end())
      {
        ClosePackage(i);
      }
    else 
      {
        bbtkError("Factory::RemovePackage(\""<<
                  p->GetName()<<"\") : package absent from factory");
      }

    bbtkDebugDecTab("kernel",9);
  }

Here is the call graph for this function:

void bbtk::Factory::Reset

(

)

Releases all the packages of the Factory.

Definition at line 88 of file bbtkFactory.cxx.

References bbtkDebugMessage, and CloseAllPackages().

  {
    bbtkDebugMessage("kernel",7,"==> Factory::Reset()"<<std::endl);
    CloseAllPackages();
    bbtkDebugMessage("kernel",7,"<== Factory::Reset()"<<std::endl);
  }

Here is the call graph for this function:

void bbtk::Factory::SetExecuter

(

ExecuterPointer

e

)

[inline]

Sets the executer who created the factory (if any).

Definition at line 151 of file bbtkFactory.h.

{ mExecuter = e; }

void bbtk::Factory::ShowGraphTypes

(

const std::string &

name

)

const

Definition at line 872 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkError, bbtk::ConfigurationFile::Get_default_temp_dir(), bbtk::ConfigurationFile::Get_file_separator(), bbtk::ConfigurationFile::GetInstance(), and mPackageMap.

 {
   bool found = false;
   PackageMapType::const_iterator i;
   for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
   {
     if (i->second->ContainsDescriptor(name)) 
       {
         std::string separator = ConfigurationFile::GetInstance().Get_file_separator ();
         
         // Don't pollute the file store with  "temp_dir" directories ...    
         std::string default_doc_dir = ConfigurationFile::GetInstance().Get_default_temp_dir();
         std::string directory = "\"" + default_doc_dir + separator + "temp_dir"  +separator + "\"";
         std::string filename2 =  default_doc_dir + separator + "temp_dir" + separator + "tmp.html"; 
         
#if defined(_WIN32)  
         std::string command("start \"Titre\" /D ");
#else 
         std::string command("gnome-open ");
#endif
         command=command + directory +" tmp.html";
         FILE *ff;
         ff=fopen(filename2.c_str(),"w");
         
         fprintf(ff,"<html><head><title>TMP</title> <script type=\"text/javascript\"> <!--\n");
         fprintf(ff,"  window.location=\"%s#%s\";\n" , i->second->GetDocURL().c_str(),name.c_str() );
         fprintf(ff,"//--></script></head><body></body></html>\n");
         
         
         //fprintf(ff, "<a  href=\"%s#%s\">Link</a>\n", i->second->GetDocURL().c_str(),name.c_str() );
         fclose(ff);
         system( command.c_str() );      
         found = true;
       }
   }
   
   bbtkDebugDecTab("kernel",9);
   if (!found) 
   {
     bbtkError("No package of the factory contains any black box <"
               <<name<<">");
   }
 }

Here is the call graph for this function:

void bbtk::Factory::UnLoadPackage

(

const std::string &

name

)

Unloads a Package which was loaded from a dynamic library.

UnLoads a package.

The package must have been previously loaded by LoadPackage. If the entry is found in the map, calls ClosePackage

Definition at line 330 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, bbtkError, ClosePackage(), bbtk::i, and mPackageMap.

 {
    bbtkDebugMessageInc("kernel",7,"Factory::UnLoadPackage(\""
                       <<name<<"\")"<<std::endl);
  
    PackageMapType::iterator i;
    i = mPackageMap.find(name);
    if (i == mPackageMap.end()) 
    {
      bbtkError("cannot unload package \""<<name
                <<"\" : package not loaded !");
    }
    ClosePackage(i);
    bbtkDebugDecTab("kernel",7);
  }

Here is the call graph for this function:

void bbtk::Object::UnLockThis

(

)

[inline, protected, inherited]

Definition at line 89 of file bbtkObject.h.

{ mThisPointerLocked = Pointer(); }

void bbtk::Factory::WriteDotFilePackagesList

(

FILE *

ff

)

Definition at line 846 of file bbtkFactory.cxx.

References bbtkDebugDecTab, bbtkDebugMessageInc, GetPackage(), and mPackageMap.

  {

    bbtkDebugMessageInc("kernel",9,"Factory::WriteDotFilePackagesList()"
                         <<std::endl);

    fprintf( ff , "\n");
    fprintf( ff , "subgraph cluster_FACTORY {\n");
    fprintf( ff , "  label = \"PACKAGES\"%s\n",  ";");
    fprintf( ff , "  style=filled%s\n",";");
    fprintf( ff , "  color=lightgrey%s\n",";");
    fprintf( ff , "  rankdir=TB%s\n",";");

    std::string url;
    PackageMapType::const_iterator i;
    for (i = mPackageMap.begin(); i!=mPackageMap.end(); ++i )
    {
       url=GetPackage(i->first)->GetDocURL();
       fprintf(ff,"  %s [shape=ellipse, URL=\"%s\"]%s\n",i->first.c_str(),url.c_str(),";" );
    }
    fprintf( ff , "}\n\n");
    bbtkDebugDecTab("kernel",9);
  }

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend struct Object::Deleter [friend]

Definition at line 55 of file bbtkFactory.h.

---

Member Data Documentation

ExecuterWeakPointer bbtk::Factory::mExecuter [private]

The executer which created the factory (if any).

Definition at line 167 of file bbtkFactory.h.

PackageMapType bbtk::Factory::mPackageMap [private]

The map of packages.

Definition at line 164 of file bbtkFactory.h.

Referenced by Check(), CloseAllPackages(), ClosePackage(), CreateHtmlIndex(), DoLoadPackage(), FindAdaptor(), FindWidgetAdaptor(), FindWidgetAdaptor2(), GetObjectRecursiveSize(), GetPackage(), GetPackageNameOfaBlackBox(), InsertPackage(), LoadPackage(), NewAdaptor(), NewBlackBox(), NewWidgetAdaptor(), PrintHelpDescriptor(), PrintHelpListPackages(), PrintHelpPackage(), RemovePackage(), ShowGraphTypes(), UnLoadPackage(), and WriteDotFilePackagesList().

---

The documentation for this class was generated from the following files:

• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkFactory.h
• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkFactory.cxx