A TRefTable maintains the association between a referenced object and the parent object supporting this referenced object.
The parent object is typically a branch of a TTree. For each object referenced in a TTree entry, the corresponding entry in the TTree's TBranchRef::fRefTable contains the index of the branch that needs to be loaded to bring the object into memory.
Persistency of a TRefTable is split into two parts:
As TObject::fUniqueID is only unique for a given TProcessID, a table of unique IDs is kept for each used TProcessID. There is no natural order of TProcessIDs, so TRefTable stores a vector of the TGUID of all known TProcessIDs in fProcessGUIDs; the index of a TProcessID in this vector defines the index of the auto-loading info in fParentIDs for that TProcessID. The mapping of TProcessID* to index is cached for quick non-persistent lookup.
Definition at line 35 of file TRefTable.h.
Public Types | |
enum | EStatusBits { kHaveWarnedReadingOld = (1ULL << ( 14 )) } |
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 | |
TRefTable () | |
Default constructor for I/O. | |
TRefTable (const TRefTable &)=delete | |
TRefTable (TObject *owner, Int_t size) | |
Create a TRefTable with initial size. | |
virtual | ~TRefTable () |
Destructor. | |
virtual Int_t | Add (Int_t uid, TProcessID *context=nullptr) |
Add a new uid to the table. | |
void | Clear (Option_t *="") override |
Clear all entries in the table. | |
virtual Int_t | Expand (Int_t pid, Int_t newsize) |
Expand fParentIDs to newsize for ProcessID pid. | |
virtual void | FillBuffer (TBuffer &b) |
Fill buffer b with the fN elements in fParentdIDs. | |
Int_t | GetN (Int_t pid) const |
Int_t | GetNumPIDs () const |
TObject * | GetOwner () const |
TObject * | GetParent (Int_t uid, TProcessID *context=nullptr) const |
Return object corresponding to uid. | |
TObjArray * | GetParents () const |
Int_t | GetSize (Int_t pid) const |
UInt_t | GetUID () const |
TProcessID * | GetUIDContext () const |
TClass * | IsA () const override |
Bool_t | Notify () override |
This function is called by TRef::Streamer or TStreamerInfo::ReadBuffer when reading a reference. | |
TRefTable & | operator= (const TRefTable &)=delete |
virtual void | ReadBuffer (TBuffer &b) |
Fill buffer b with the fN elements in fParentdIDs. | |
virtual void | Reset (Option_t *="") |
Clear all entries in the table. | |
virtual Int_t | SetParent (const TObject *parent, Int_t branchID) |
– Set current parent object, typically a branch of a tree. | |
virtual void | SetUID (UInt_t uid, TProcessID *context=nullptr) |
void | Streamer (TBuffer &) override |
Stream an object of class TRefTable. | |
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 TObject * | Clone (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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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). | |
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) |
TObject & | operator= (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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
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 TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static TRefTable * | GetRefTable () |
Static function returning the current TRefTable. | |
static void | SetRefTable (TRefTable *table) |
Static function setting the current TRefTable. | |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
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. | |
Protected Member Functions | |
Int_t | AddInternalIdxForPID (TProcessID *procid) |
Add the internal index for fProcessIDs, fAllocSize, etc given a PID. | |
virtual Int_t | ExpandForIID (Int_t iid, Int_t newsize) |
Expand fParentIDs to newsize for internel ProcessID index iid. | |
void | ExpandPIDs (Int_t numpids) |
Expand the arrays of managed PIDs. | |
Int_t | FindPIDGUID (const char *guid) const |
Get fProcessGUIDs' index of the TProcessID with GUID guid. | |
Int_t | GetInternalIdxForPID (Int_t pid) const |
Get the index for fProcessIDs, fAllocSize, etc given a PID. | |
Int_t | GetInternalIdxForPID (TProcessID *procid) const |
Get the index for fProcessIDs, fAllocSize, etc given a PID. | |
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 () |
Protected Attributes | |
Int_t * | fAllocSize |
number of known ProcessIDs | |
Int_t | fDefaultSize |
current parent ID in fParents (latest call to SetParent) | |
std::vector< Int_t > | fMapPIDtoInternal |
Int_t * | fN |
[fNumPIDs] allocated size of array fParentIDs for each ProcessID | |
Int_t | fNumPIDs |
TObject * | fOwner |
Int_t | fParentID |
[fNumPIDs][fAllocSize] array of Parent IDs | |
Int_t ** | fParentIDs |
[fNumPIDs] current maximum number of IDs in array fParentIDs for each ProcessID | |
TObjArray * | fParents |
std::vector< std::string > | fProcessGUIDs |
Int_t | fSize |
TProcessID the current uid is referring to. | |
UInt_t | fUID |
default size for a new PID array | |
TProcessID * | fUIDContext |
Current uid (set by TRef::GetObject) | |
Static Protected Attributes | |
static TRefTable * | fgRefTable = nullptr |
cache of pid to index in fProcessGUIDs | |
Additional Inherited Members | |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
#include <TRefTable.h>
Enumerator | |
---|---|
kHaveWarnedReadingOld |
Definition at line 62 of file TRefTable.h.
TRefTable::TRefTable | ( | ) |
Default constructor for I/O.
Definition at line 52 of file TRefTable.cxx.
Create a TRefTable with initial size.
Definition at line 61 of file TRefTable.cxx.
|
virtual |
Destructor.
Definition at line 71 of file TRefTable.cxx.
|
delete |
|
virtual |
Add a new uid to the table.
we add a new pair (uid,fparent) to the map This function is called by TObject::Streamer or TStreamerInfo::WriteBuffer
Definition at line 88 of file TRefTable.cxx.
|
protected |
Add the internal index for fProcessIDs, fAllocSize, etc given a PID.
Definition at line 119 of file TRefTable.cxx.
|
static |
|
inlinestaticconstexpr |
Definition at line 93 of file TRefTable.h.
|
overridevirtual |
Clear all entries in the table.
Reimplemented from TObject.
Definition at line 145 of file TRefTable.cxx.
|
inlinestatic |
Definition at line 93 of file TRefTable.h.
Expand fParentIDs to newsize for ProcessID pid.
Definition at line 157 of file TRefTable.cxx.
Expand fParentIDs to newsize for internel ProcessID index iid.
Definition at line 167 of file TRefTable.cxx.
|
protected |
Expand the arrays of managed PIDs.
Definition at line 193 of file TRefTable.cxx.
|
virtual |
Fill buffer b with the fN elements in fParentdIDs.
This function is called by TBranchRef::FillLeaves.
Definition at line 225 of file TRefTable.cxx.
|
protected |
Get fProcessGUIDs' index of the TProcessID with GUID guid.
Definition at line 238 of file TRefTable.cxx.
Get the index for fProcessIDs, fAllocSize, etc given a PID.
Uses fMapPIDtoInternal and the pid's GUID / fProcessGUID
Definition at line 278 of file TRefTable.cxx.
|
protected |
Get the index for fProcessIDs, fAllocSize, etc given a PID.
Uses fMapPIDtoInternal and the pid's GUID / fProcessGUID
Definition at line 269 of file TRefTable.cxx.
Definition at line 80 of file TRefTable.h.
|
inline |
Definition at line 78 of file TRefTable.h.
|
inline |
Definition at line 81 of file TRefTable.h.
TObject * TRefTable::GetParent | ( | Int_t | uid, |
TProcessID * | context = nullptr |
||
) | const |
Return object corresponding to uid.
Definition at line 249 of file TRefTable.cxx.
|
inline |
Definition at line 83 of file TRefTable.h.
|
static |
Static function returning the current TRefTable.
Definition at line 287 of file TRefTable.cxx.
Definition at line 79 of file TRefTable.h.
|
inline |
Definition at line 84 of file TRefTable.h.
|
inline |
Definition at line 85 of file TRefTable.h.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 93 of file TRefTable.h.
|
overridevirtual |
This function is called by TRef::Streamer or TStreamerInfo::ReadBuffer when reading a reference.
This function, in turns, notifies the TRefTable owner for action. eg, when the owner is a TBranchRef, TBranchRef::Notify is called to read the branch containing the referenced object.
Reimplemented from TObject.
Definition at line 299 of file TRefTable.cxx.
|
virtual |
Fill buffer b with the fN elements in fParentdIDs.
This function is called by TBranchRef::ReadLeaves
Definition at line 308 of file TRefTable.cxx.
|
virtual |
Clear all entries in the table.
Definition at line 345 of file TRefTable.cxx.
– Set current parent object, typically a branch of a tree.
This function is called by TBranchElement::Fill() and by TBranchElement::GetEntry().
Definition at line 357 of file TRefTable.cxx.
|
static |
Static function setting the current TRefTable.
Definition at line 383 of file TRefTable.cxx.
|
inlinevirtual |
Definition at line 91 of file TRefTable.h.
|
overridevirtual |
Stream an object of class TRefTable.
Reimplemented from TObject.
Definition at line 391 of file TRefTable.cxx.
|
inline |
Definition at line 93 of file TRefTable.h.
|
protected |
number of known ProcessIDs
Definition at line 39 of file TRefTable.h.
|
protected |
current parent ID in fParents (latest call to SetParent)
Definition at line 43 of file TRefTable.h.
|
staticprotected |
cache of pid to index in fProcessGUIDs
Definition at line 51 of file TRefTable.h.
|
protected |
Definition at line 50 of file TRefTable.h.
|
protected |
[fNumPIDs] allocated size of array fParentIDs for each ProcessID
Definition at line 40 of file TRefTable.h.
|
protected |
Definition at line 38 of file TRefTable.h.
|
protected |
Definition at line 48 of file TRefTable.h.
|
protected |
[fNumPIDs][fAllocSize] array of Parent IDs
Definition at line 42 of file TRefTable.h.
|
protected |
[fNumPIDs] current maximum number of IDs in array fParentIDs for each ProcessID
Definition at line 41 of file TRefTable.h.
|
protected |
Definition at line 47 of file TRefTable.h.
|
protected |
Definition at line 49 of file TRefTable.h.
|
protected |
TProcessID the current uid is referring to.
Definition at line 46 of file TRefTable.h.
|
protected |
default size for a new PID array
Definition at line 44 of file TRefTable.h.
|
protected |
Current uid (set by TRef::GetObject)
Definition at line 45 of file TRefTable.h.