ROOT  6.06/09
Reference Guide
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
TObjectTable Class Reference

This class registers all instances of TObject and its derived classes in a hash table.

The Add() and Remove() members are called from the TObject ctor and dtor, respectively. Using the Print() member one can see all currently active objects in the system. Using the resource (in .rootrc): Root.ObjectStat one can toggle this feature on or off.

Using the compile option R__NOSTATS one can de-active this feature for the entire system (for maximum performance in highly time critical applications).

The following output has been produced in a ROOT interactive session via the command gObjectTable->Print()

class cnt on heap size total size heap size
============================================================================
TKey 4 4 72 288 288
TClass 84 84 80 6720 6720
TDataMember 276 276 24 6624 6624
TObject 11 11 12 132 132
TMethod 1974 1974 64 126336 126336
TDataType 34 34 56 1904 1904
TList 2328 2328 36 83808 83808
TH1F 1 1 448 448 448
TText 2688 2688 56 150528 150528
TGaxis 1 0 120 120 0
TAxis 6 3 88 528 264
TBox 57 57 52 2964 2964
TLine 118 118 40 4720 4720
TWbox 1 1 56 56 56
TArrow 1 1 64 64 64
TPaveText 59 59 124 7316 7316
TPave 1 1 92 92 92
TFile 1 1 136 136 136
TCanvas 3 3 444 1332 1332
TPad 1 1 312 312 312
TContextMenu 3 3 48 144 144
TMethodArg 2166 2166 44 95304 95304
TPaveLabel 1 1 120 120 120
THtml 1 1 32 32 32
TROOT 1 0 208 208 0
TApplication 1 1 28 28 28
TFileHandler 1 1 20 20 20
TColor 163 163 40 6520 6520
TStyle 1 1 364 364 364
TRealData 117 117 28 3276 3276
TBaseClass 88 88 36 3168 3168
THashList 5 5 40 200 200
THashTable 5 5 36 180 180
TGeometry 1 1 64 64 64
TLink 7 7 60 420 420
TPostScript 1 1 764 764 764
TMinuit 1 1 792 792 792
TStopwatch 1 0 56 56 0
TRootGuiFactory 1 1 28 28 28
TGX11 1 1 172 172 172
TUnixSystem 1 1 252 252 252
TSignalHandler 1 1 20 20 20
TOrdCollection 3 3 40 120 120
TEnv 1 1 24 24 24
TCling 1 1 208 208 208
TBenchmark 1 1 52 52 52
TClassTable 1 1 12 12 12
TObjectTable 1 1 12 12 12
----------------------------------------------------------------------------
Total: 10225 10219 5976 506988 506340
============================================================================

Definition at line 37 of file TObjectTable.h.

Public Member Functions

 TObjectTable (Int_t tableSize=100)
 
 ~TObjectTable ()
 Delete TObjectTable. More...
 
void Add (TObject *obj)
 Add an object to the object table. More...
 
voidCheckPtrAndWarn (const char *msg, void *vp)
 Issue a warning in case an object still appears in the table while it should not. More...
 
void Delete (Option_t *opt="")
 Delete all objects stored in the TObjectTable. More...
 
Int_t GetSize () const
 
Int_t Instances () const
 
void InstanceStatistics () const
 Print the object table. More...
 
void Print (Option_t *option="") const
 Print the object table. More...
 
Bool_t PtrIsValid (TObject *obj)
 
void Remove (TObject *obj)
 Remove an object from the object table. More...
 
void RemoveQuietly (TObject *obj)
 Remove an object from the object table. More...
 
void Statistics ()
 
void Terminate ()
 Deletes the object table (this static class function calls the dtor). More...
 
void UpdateInstCount () const
 Histogram all objects according to their classes. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Static Public Member Functions

static void AddObj (TObject *obj)
 Add an object to the global object table gObjectTable. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Private Member Functions

Bool_t HighWaterMark ()
 
void Expand (Int_t newsize)
 Expand the object table. More...
 
Int_t FindElement (TObject *obj)
 Find an object in the object table. More...
 
void FixCollisions (Int_t index)
 Rehash the object table in case an object has been removed. More...
 
 TObjectTable (const TObjectTable &)
 
TObjectTableoperator= (const TObjectTable &)
 

Private Attributes

TObject ** fTable
 
Int_t fSize
 
Int_t fTally
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TObjectTable.h>

+ Inheritance diagram for TObjectTable:
+ Collaboration diagram for TObjectTable:

Constructor & Destructor Documentation

TObjectTable::TObjectTable ( const TObjectTable )
private

Referenced by AddObj().

TObjectTable::TObjectTable ( Int_t  tableSize = 100)
TObjectTable::~TObjectTable ( )

Delete TObjectTable.

Definition at line 108 of file TObjectTable.cxx.

Member Function Documentation

void TObjectTable::Add ( TObject obj)

Add an object to the object table.

Definition at line 145 of file TObjectTable.cxx.

Referenced by AddObj(), Expand(), and TCollection::GarbageCollect().

void TObjectTable::AddObj ( TObject op)
static

Add an object to the global object table gObjectTable.

If the global table does not exist create it first. This member function may only be used by TObject::TObject. Use Add() to add objects to any other TObjectTable object. This is a static function.

Definition at line 169 of file TObjectTable.cxx.

Referenced by ClassImp(), and TObject::TObject().

void * TObjectTable::CheckPtrAndWarn ( const char *  msg,
void vp 
)

Issue a warning in case an object still appears in the table while it should not.

Definition at line 394 of file TObjectTable.cxx.

void TObjectTable::Delete ( Option_t opt = "")
virtual

Delete all objects stored in the TObjectTable.

Reimplemented from TObject.

Definition at line 193 of file TObjectTable.cxx.

Referenced by TCollection::EmptyGarbageCollection().

void TObjectTable::Expand ( Int_t  newsize)
private

Expand the object table.

Definition at line 319 of file TObjectTable.cxx.

Referenced by Add().

Int_t TObjectTable::FindElement ( TObject op)
private

Find an object in the object table.

Returns the slot where to put the object. To test if the object is actually already in the table use PtrIsValid().

Definition at line 273 of file TObjectTable.cxx.

Referenced by Add(), CheckPtrAndWarn(), FixCollisions(), PtrIsValid(), Remove(), and RemoveQuietly().

void TObjectTable::FixCollisions ( Int_t  index)
private

Rehash the object table in case an object has been removed.

Definition at line 297 of file TObjectTable.cxx.

Referenced by Remove(), and RemoveQuietly().

Int_t TObjectTable::GetSize ( ) const
inline

Definition at line 60 of file TObjectTable.h.

Bool_t TObjectTable::HighWaterMark ( )
inlineprivate

Definition at line 77 of file TObjectTable.h.

Referenced by Add().

Int_t TObjectTable::Instances ( ) const
inline

Definition at line 61 of file TObjectTable.h.

void TObjectTable::InstanceStatistics ( ) const

Print the object table.

Definition at line 337 of file TObjectTable.cxx.

Referenced by Print(), and Terminate().

TObjectTable& TObjectTable::operator= ( const TObjectTable )
private
void TObjectTable::Print ( Option_t option = "") const
virtual

Print the object table.

If option ="all" prints the list of all objects with the format object number, pointer, class name, object name

Reimplemented from TObject.

Definition at line 118 of file TObjectTable.cxx.

Referenced by Statistics().

Bool_t TObjectTable::PtrIsValid ( TObject obj)
inline

Definition at line 80 of file TObjectTable.h.

Referenced by THashTable::Rehash().

void TObjectTable::Remove ( TObject obj)

Remove an object from the object table.

Definition at line 207 of file TObjectTable.cxx.

Referenced by CheckPtrAndWarn().

void TObjectTable::RemoveQuietly ( TObject op)

Remove an object from the object table.

If op is 0 or not in the table don't complain. Currently only used by the TClonesArray dtor. Should not be used anywhere else, except in places where "special" allocation and de-allocation tricks are performed.

Definition at line 241 of file TObjectTable.cxx.

Referenced by TClonesArray::Expand(), TClonesArray::ExpandCreate(), TClonesArray::operator=(), TClonesArray::~TClonesArray(), and TObject::~TObject().

void TObjectTable::Statistics ( )
inline

Definition at line 67 of file TObjectTable.h.

void TObjectTable::Terminate ( void  )

Deletes the object table (this static class function calls the dtor).

Definition at line 262 of file TObjectTable.cxx.

void TObjectTable::UpdateInstCount ( ) const

Histogram all objects according to their classes.

Definition at line 372 of file TObjectTable.cxx.

Referenced by InstanceStatistics().

Member Data Documentation

Int_t TObjectTable::fSize
private
TObject** TObjectTable::fTable
private
Int_t TObjectTable::fTally
private

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