Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TClassTable Class Reference

This class registers for all classes their name, id and dictionary function in a hash table.

Classes are automatically added by the ctor of a special init class when a global of this init class is initialized when the program starts (see the ClassImp macro).

All functions in TClassTable are thread-safe.

Definition at line 37 of file TClassTable.h.

Classes

class  NormalizeThenLock
 

Public Types

enum  {
  kNoStreamer = 0x01 , kNoInputOperator = 0x02 , kAutoStreamer = 0x04 , kHasVersion = 0x08 ,
  kHasCustomStreamerMember = 0x10 , kNtplForceSplit = 0x20 , kNtplForceUnsplit = 0x40
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

 ~TClassTable ()
 TClassTable singleton is deleted in Terminate().
 
int Classes ()
 
TClassIsA () const override
 
void Print (Option_t *option="") const override
 Print the class table.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static void Add (const char *cname, Version_t id, const std::type_info &info, DictFuncPtr_t dict, Int_t pragmabits)
 Add a class to the class table (this is a static function).
 
static void Add (TProtoClass *protoClass)
 Add a class to the class table (this is a static function).
 
static ROOT::TClassAltAddAlternate (const char *normname, const char *alternate)
 
static char * At (UInt_t index)
 Returns class at index from sorted class table.
 
static Bool_t Check (const char *cname, std::string &normname)
 
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static DictFuncPtr_t GetDict (const char *cname)
 Given the class name returns the Dictionary() function of a class (uses hash of name).
 
static DictFuncPtr_t GetDict (const std::type_info &info)
 Given the std::type_info returns the Dictionary() function of a class (uses hash of std::type_info::name()).
 
static DictFuncPtr_t GetDictNorm (const char *cname)
 Given the normalized class name returns the Dictionary() function of a class (uses hash of name).
 
static Version_t GetID (const char *cname)
 Returns the ID of a class.
 
static Int_t GetPragmaBits (const char *name)
 Returns the pragma bits as specified in the LinkDef.h file.
 
static TProtoClassGetProto (const char *cname)
 Given the class name returns the TClassProto object for the class.
 
static TProtoClassGetProtoNorm (const char *cname)
 Given the class normalized name returns the TClassProto object for the class.
 
static void Init ()
 
static char * Next ()
 Returns next class from sorted class table.
 
static void PrintTable ()
 Print the class table.
 
static void Remove (const char *cname)
 Remove a class from the class table.
 
static void RemoveAlternate (ROOT::TClassAlt *alt)
 
static void Terminate ()
 Deletes the class table (this static class function calls the dtor).
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Private Types

typedef ROOT::TMapTypeToClassRec IdMap_t
 

Private Member Functions

 TClassTable ()
 TClassTable is a singleton (i.e. only one can exist per application).
 

Static Private Member Functions

static Bool_t CheckClassTableInit ()
 Return true fs the table exist.
 
static ROOT::TClassRecFindElement (const char *cname, Bool_t insert)
 Find a class by name in the class table (using hash of name).
 
static void SortTable ()
 Sort the class table by ascending class ID's.
 

Static Private Attributes

static ROOT::TClassAlt ** fgAlternate
 
static UInt_t fgCursor
 
static IdMap_tfgIdMap
 
static UInt_t fgSize
 
static Bool_t fgSorted
 
static ROOT::TClassRec ** fgSortedTable
 
static ROOT::TClassRec ** fgTable
 
static std::atomic< UInt_tfgTally
 

Friends

void ROOT::ResetClassVersion (TClass *, const char *, Short_t)
 
class TROOT
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TClassTable.h>

Inheritance diagram for TClassTable:
[legend]

Member Typedef Documentation

◆ IdMap_t

Definition at line 43 of file TClassTable.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kNoStreamer 
kNoInputOperator 
kAutoStreamer 
kHasVersion 
kHasCustomStreamerMember 
kNtplForceSplit 
kNtplForceUnsplit 

Definition at line 65 of file TClassTable.h.

Constructor & Destructor Documentation

◆ TClassTable()

TClassTable::TClassTable ( )
private

TClassTable is a singleton (i.e. only one can exist per application).

Definition at line 264 of file TClassTable.cxx.

◆ ~TClassTable()

TClassTable::~TClassTable ( )

TClassTable singleton is deleted in Terminate().

Definition at line 290 of file TClassTable.cxx.

Member Function Documentation

◆ Add() [1/2]

void TClassTable::Add ( const char *  cname,
Version_t  id,
const std::type_info &  info,
DictFuncPtr_t  dict,
Int_t  pragmabits 
)
static

Add a class to the class table (this is a static function).

Note that the given cname must be already normalized.

Definition at line 398 of file TClassTable.cxx.

◆ Add() [2/2]

void TClassTable::Add ( TProtoClass protoClass)
static

Add a class to the class table (this is a static function).

Definition at line 458 of file TClassTable.cxx.

◆ AddAlternate()

ROOT::TClassAlt * TClassTable::AddAlternate ( const char *  normname,
const char *  alternate 
)
static

Definition at line 507 of file TClassTable.cxx.

◆ At()

char * TClassTable::At ( UInt_t  index)
static

Returns class at index from sorted class table.

Don't use this iterator while modifying the class table. The class table can be modified when making calls like TClass::GetClass(), etc. Returns 0 if index points beyond last class name.

Definition at line 374 of file TClassTable.cxx.

◆ Check()

Bool_t TClassTable::Check ( const char *  cname,
std::string &  normname 
)
static

Definition at line 563 of file TClassTable.cxx.

◆ CheckClassTableInit()

Bool_t TClassTable::CheckClassTableInit ( )
inlinestaticprivate

Return true fs the table exist.

If the table does not exist but the delayed list does, then create the table and return true.

Definition at line 308 of file TClassTable.cxx.

◆ Class()

static TClass * TClassTable::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TClassTable::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TClassTable::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 101 of file TClassTable.h.

◆ Classes()

int TClassTable::Classes ( )

Definition at line 388 of file TClassTable.cxx.

◆ DeclFileName()

static const char * TClassTable::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 101 of file TClassTable.h.

◆ FindElement()

TClassRec * TClassTable::FindElement ( const char *  cname,
Bool_t  insert 
)
staticprivate

Find a class by name in the class table (using hash of name).

Returns 0 if the class is not in the table. Unless arguments insert is true in which case a new entry is created and returned. cname must be the normalized name of the class.

Definition at line 625 of file TClassTable.cxx.

◆ GetDict() [1/2]

DictFuncPtr_t TClassTable::GetDict ( const char *  cname)
static

Given the class name returns the Dictionary() function of a class (uses hash of name).

Definition at line 674 of file TClassTable.cxx.

◆ GetDict() [2/2]

DictFuncPtr_t TClassTable::GetDict ( const std::type_info &  info)
static

Given the std::type_info returns the Dictionary() function of a class (uses hash of std::type_info::name()).

Definition at line 692 of file TClassTable.cxx.

◆ GetDictNorm()

DictFuncPtr_t TClassTable::GetDictNorm ( const char *  cname)
static

Given the normalized class name returns the Dictionary() function of a class (uses hash of name).

Definition at line 717 of file TClassTable.cxx.

◆ GetID()

Version_t TClassTable::GetID ( const char *  cname)
static

Returns the ID of a class.

Definition at line 647 of file TClassTable.cxx.

◆ GetPragmaBits()

Int_t TClassTable::GetPragmaBits ( const char *  name)
static

Returns the pragma bits as specified in the LinkDef.h file.

Definition at line 660 of file TClassTable.cxx.

◆ GetProto()

TProtoClass * TClassTable::GetProto ( const char *  cname)
static

Given the class name returns the TClassProto object for the class.

(uses hash of name).

Definition at line 742 of file TClassTable.cxx.

◆ GetProtoNorm()

TProtoClass * TClassTable::GetProtoNorm ( const char *  cname)
static

Given the class normalized name returns the TClassProto object for the class.

(uses hash of name).

Definition at line 770 of file TClassTable.cxx.

◆ Init()

void TClassTable::Init ( )
static

Definition at line 390 of file TClassTable.cxx.

◆ IsA()

TClass * TClassTable::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 101 of file TClassTable.h.

◆ Next()

char * TClassTable::Next ( )
static

Returns next class from sorted class table.

Don't use this iterator while modifying the class table. The class table can be modified when making calls like TClass::GetClass(), etc.

Definition at line 807 of file TClassTable.cxx.

◆ Print()

void TClassTable::Print ( Option_t option = "") const
overridevirtual

Print the class table.

Before printing the table is sorted alphabetically. Only classes specified in option are listed. The default is to list all classes. Standard wildcarding notation supported.

Reimplemented from TObject.

Definition at line 328 of file TClassTable.cxx.

◆ PrintTable()

void TClassTable::PrintTable ( )
static

Print the class table.

Before printing the table is sorted alphabetically.

Definition at line 823 of file TClassTable.cxx.

◆ Remove()

void TClassTable::Remove ( const char *  cname)
static

Remove a class from the class table.

This happens when a shared library is unloaded (i.e. the dtor's of the global init objects are called).

Definition at line 591 of file TClassTable.cxx.

◆ RemoveAlternate()

void TClassTable::RemoveAlternate ( ROOT::TClassAlt alt)
static

Definition at line 535 of file TClassTable.cxx.

◆ SortTable()

void TClassTable::SortTable ( )
staticprivate

Sort the class table by ascending class ID's.

Definition at line 857 of file TClassTable.cxx.

◆ Streamer()

void TClassTable::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TClassTable::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 101 of file TClassTable.h.

◆ Terminate()

void TClassTable::Terminate ( )
static

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

Definition at line 878 of file TClassTable.cxx.

Friends And Related Symbol Documentation

◆ ROOT::ResetClassVersion

void ROOT::ResetClassVersion ( TClass ,
const char *  ,
Short_t   
)
friend

◆ TROOT

friend class TROOT
friend

Definition at line 40 of file TClassTable.h.

Member Data Documentation

◆ fgAlternate

TClassAlt ** TClassTable::fgAlternate
staticprivate

Definition at line 46 of file TClassTable.h.

◆ fgCursor

UInt_t TClassTable::fgCursor
staticprivate

Definition at line 53 of file TClassTable.h.

◆ fgIdMap

TClassTable::IdMap_t * TClassTable::fgIdMap
staticprivate

Definition at line 49 of file TClassTable.h.

◆ fgSize

UInt_t TClassTable::fgSize
staticprivate

Definition at line 50 of file TClassTable.h.

◆ fgSorted

Bool_t TClassTable::fgSorted
staticprivate

Definition at line 52 of file TClassTable.h.

◆ fgSortedTable

TClassRec ** TClassTable::fgSortedTable
staticprivate

Definition at line 48 of file TClassTable.h.

◆ fgTable

TClassRec ** TClassTable::fgTable
staticprivate

Definition at line 47 of file TClassTable.h.

◆ fgTally

std::atomic< UInt_t > TClassTable::fgTally
staticprivate

Definition at line 51 of file TClassTable.h.

Libraries for TClassTable:

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