bbtk::Object Class Reference

#include <bbtkObject.h>

Inheritance diagram for bbtk::Object:

[legend]

List of all members.

Classes
struct	Deleter
	Default objects deleter : removes object from list on deletion. More...
Public Types
typedef boost::shared_ptr< Object >	Pointer
typedef boost::weak_ptr< Object >	WeakPointer
Public Member Functions
	Object ()
virtual	~Object ()
virtual std::string	GetObjectName () const
virtual std::string	GetObjectInfo () const
virtual size_t	GetObjectSize () const
virtual size_t	GetObjectInternalSize () const
virtual size_t	GetObjectRecursiveSize () const
long	GetUseCount ()
Static Public Member Functions
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 Member Functions
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 Types
typedef std::set < boost::weak_ptr< Object > >	ObjectListType
Private Attributes
WeakPointer	mThisPointer
Pointer	mThisPointerLocked
Static Private Attributes
static ObjectListType	mgObjectList
static ObjectListType	mgPackageList

---

Detailed Description

Definition at line 49 of file bbtkObject.h.

---

Member Typedef Documentation

typedef std::set<boost::weak_ptr<Object> > bbtk::Object::ObjectListType [private]

Definition at line 136 of file bbtkObject.h.

typedef boost::shared_ptr<Object> bbtk::Object::Pointer

Reimplemented in bbtk::BlackBox, bbtk::BlackBoxDescriptor, bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, bbtk::QtBlackBox, bbtk::QtBlackBoxDescriptor, bbtk::Transcriptor, bbtk::VirtualExec, bbtk::WidgetBlackBox< W >, bbtk::WidgetBlackBoxDescriptor< T >, bbtk::WxBlackBox, bbtk::WxBlackBoxDescriptor, bbtk::WidgetBlackBox< QWidget >, bbtk::WidgetBlackBox< wxWindow >, bbtk::WidgetBlackBoxDescriptor< QWidget >, and bbtk::WidgetBlackBoxDescriptor< wxWindow >.

Definition at line 52 of file bbtkObject.h.

typedef boost::weak_ptr<Object> bbtk::Object::WeakPointer

Reimplemented in bbtk::BlackBox, bbtk::BlackBoxDescriptor, bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, bbtk::QtBlackBox, bbtk::QtBlackBoxDescriptor, bbtk::Transcriptor, bbtk::VirtualExec, bbtk::WidgetBlackBox< W >, bbtk::WidgetBlackBoxDescriptor< T >, bbtk::WxBlackBox, bbtk::WxBlackBoxDescriptor, bbtk::WidgetBlackBox< QWidget >, bbtk::WidgetBlackBox< wxWindow >, bbtk::WidgetBlackBoxDescriptor< QWidget >, and bbtk::WidgetBlackBoxDescriptor< wxWindow >.

Definition at line 53 of file bbtkObject.h.

---

Constructor & Destructor Documentation

bbtk::Object::Object

(

)

Definition at line 46 of file bbtkObject.cxx.

  { 
  }

bbtk::Object::~Object

(

)

[virtual]

Definition at line 53 of file bbtkObject.cxx.

  { 
  }

---

Member Function Documentation

std::string bbtk::Object::GetObjectInfo

(

)

const [virtual]

Reimplemented in bbtk::AtomicBlackBox, bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, and bbtk::Transcriptor.

Definition at line 98 of file bbtkObject.cxx.

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

virtual size_t bbtk::Object::GetObjectInternalSize

(

)

const [inline, virtual]

Reimplemented in bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, and bbtk::Transcriptor.

Definition at line 61 of file bbtkObject.h.

{ return sizeof(Object); }

std::string bbtk::Object::GetObjectName

(

)

const [virtual]

Reimplemented in bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, bbtk::QtBlackBox, bbtk::QtBlackBoxDescriptor, bbtk::Transcriptor, bbtk::WidgetBlackBox< W >, bbtk::WidgetBlackBoxDescriptor< T >, bbtk::WxBlackBox, bbtk::WxBlackBoxDescriptor, bbtk::WidgetBlackBox< QWidget >, bbtk::WidgetBlackBox< wxWindow >, bbtk::WidgetBlackBoxDescriptor< QWidget >, and bbtk::WidgetBlackBoxDescriptor< wxWindow >.

Definition at line 91 of file bbtkObject.cxx.

Referenced by bbtk::BlackBox::Deleter::Delete(), and bbtk::Object::Deleter::operator()().

  {
    return std::string("**Unknown object**");
  }

Here is the caller graph for this function:

virtual size_t bbtk::Object::GetObjectRecursiveSize

(

)

const [inline, virtual]

Reimplemented in bbtk::AtomicBlackBox, bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, and bbtk::Transcriptor.

Definition at line 62 of file bbtkObject.h.

Referenced by bbtk::Transcriptor::GetObjectRecursiveSize(), bbtk::Package::GetObjectRecursiveSize(), bbtk::InterpreterVirtual::GetObjectRecursiveSize(), bbtk::Interpreter::GetObjectRecursiveSize(), bbtk::Factory::GetObjectRecursiveSize(), bbtk::Executer::GetObjectRecursiveSize(), bbtk::Connection::GetObjectRecursiveSize(), bbtk::ComplexBlackBoxDescriptor::GetObjectRecursiveSize(), and bbtk::ComplexBlackBox::GetObjectRecursiveSize().

{ return sizeof(Object); }

Here is the caller graph for this function:

static long bbtk::Object::GetObjectsCount

(

)

[inline, static]

Definition at line 75 of file bbtkObject.h.

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

{ return mgObjectList.size(); }

Here is the caller graph for this function:

virtual size_t bbtk::Object::GetObjectSize

(

)

const [inline, virtual]

Reimplemented in bbtk::AtomicBlackBox, bbtk::ComplexBlackBox, bbtk::ComplexBlackBoxDescriptor, bbtk::Connection, bbtk::Executer, bbtk::Factory, bbtk::Interpreter, bbtk::InterpreterVirtual, bbtk::Package, bbtk::QtBlackBoxDescriptor, bbtk::Transcriptor, and bbtk::WxBlackBoxDescriptor.

Definition at line 60 of file bbtkObject.h.

Referenced by bbtk::Transcriptor::GetObjectSize(), bbtk::Package::GetObjectSize(), bbtk::InterpreterVirtual::GetObjectSize(), bbtk::Interpreter::GetObjectSize(), bbtk::Factory::GetObjectSize(), bbtk::Executer::GetObjectSize(), bbtk::Connection::GetObjectSize(), bbtk::ComplexBlackBoxDescriptor::GetObjectSize(), and bbtk::ComplexBlackBox::GetObjectSize().

{ return sizeof(Object); }

Here is the caller graph for this function:

template<class U >

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

(

)

const [inline, protected]

Definition at line 92 of file bbtkObject.h.

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

long bbtk::Object::GetUseCount

(

)

[inline]

Definition at line 63 of file bbtkObject.h.

{ return mThisPointer.use_count(); }

void bbtk::Object::InsertInObjectList

(

Pointer

p

)

[static]

Definition at line 59 of file bbtkObject.cxx.

References bbtkDebugMessage, and mgObjectList.

Referenced by 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]

Definition at line 69 of file bbtkObject.cxx.

References bbtkDebugMessage, and mgPackageList.

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

void bbtk::Object::LockThis

(

)

[inline, protected]

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]

Definition at line 115 of file bbtkObject.h.

References 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]

Definition at line 97 of file bbtkObject.h.

References InsertInObjectList().

Referenced by bbtk::ComplexBlackBoxDescriptor::ComplexBlackBoxDescriptor(), bbtk::Executer::Executer(), bbtk::Interpreter::Init(), bbtk::Transcriptor::New(), bbtk::Package::New(), bbtk::InterpreterVirtual::New(), bbtk::Interpreter::New(), bbtk::Factory::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:

void bbtk::Object::PrintObjectInfo

(

const Pointer &

o

)

[static]

Definition at line 180 of file bbtkObject.cxx.

Referenced by 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]

Definition at line 105 of file bbtkObject.cxx.

References bbtk::i, mgObjectList, and 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]

Definition at line 222 of file bbtkObject.cxx.

References bbtkDebugMessage, bbtk::i, 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]

Definition at line 80 of file bbtkObject.cxx.

References bbtkDebugMessage, and 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::Object::UnLockThis

(

)

[inline, protected]

Definition at line 89 of file bbtkObject.h.

{ mThisPointerLocked = Pointer(); }

---

Member Data Documentation

Object::ObjectListType bbtk::Object::mgObjectList [static, private]

Definition at line 137 of file bbtkObject.h.

Referenced by InsertInObjectList(), PrintObjectListInfo(), and RemoveFromObjectList().

Object::ObjectListType bbtk::Object::mgPackageList [static, private]

Definition at line 138 of file bbtkObject.h.

Referenced by InsertInPackageList(), and ReleasePackages().

WeakPointer bbtk::Object::mThisPointer [private]

Definition at line 139 of file bbtkObject.h.

Pointer bbtk::Object::mThisPointerLocked [private]

Definition at line 140 of file bbtkObject.h.

---

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

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