Logo ROOT   6.11/03
Reference Guide
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
TRefTable Class Reference

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 = BIT(14) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TRefTable ()
 Default constructor for I/O. More...
 
 TRefTable (TObject *owner, Int_t size)
 Create a TRefTable with initial size. More...
 
virtual ~TRefTable ()
 Destructor. More...
 
virtual Int_t Add (Int_t uid, TProcessID *context=0)
 Add a new uid to the table. More...
 
virtual void Clear (Option_t *="")
 Clear all entries in the table. More...
 
virtual Int_t Expand (Int_t pid, Int_t newsize)
 Expand fParentIDs to newsize for ProcessID pid. More...
 
virtual void FillBuffer (TBuffer &b)
 Fill buffer b with the fN elements in fParentdIDs. More...
 
Int_t GetN (Int_t pid) const
 
Int_t GetNumPIDs () const
 
TObjectGetOwner () const
 
TObjectGetParent (Int_t uid, TProcessID *context=0) const
 Return object corresponding to uid. More...
 
TObjArrayGetParents () const
 
Int_t GetSize (Int_t pid) const
 
UInt_t GetUID () const
 
TProcessIDGetUIDContext () const
 
virtual Bool_t Notify ()
 This function is called by TRef::Streamer or TStreamerInfo::ReadBuffer when reading a reference. More...
 
virtual void ReadBuffer (TBuffer &b)
 Fill buffer b with the fN elements in fParentdIDs. More...
 
virtual void Reset (Option_t *="")
 Clear all entries in the table. More...
 
virtual Int_t SetParent (const TObject *parent, Int_t branchID)
 – Set current parent object, typically a branch of a tree. More...
 
virtual void SetUID (UInt_t uid, TProcessID *context=0)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
ULong_t CheckedHash ()
 Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
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 void Delete (Option_t *option="")
 Delete this object. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. 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...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. 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...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
void ResetBit (UInt_t f)
 
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...
 
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)
 
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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Static Public Member Functions

static TRefTableGetRefTable ()
 Static function returning the current TRefTable. More...
 
static void SetRefTable (TRefTable *table)
 Static function setting the current TRefTable. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

Int_t AddInternalIdxForPID (TProcessID *procid)
 Add the internal index for fProcessIDs, fAllocSize, etc given a PID. More...
 
virtual Int_t ExpandForIID (Int_t iid, Int_t newsize)
 Expand fParentIDs to newsize for internel ProcessID index iid. More...
 
void ExpandPIDs (Int_t numpids)
 Expand the arrays of managed PIDs. More...
 
Int_t FindPIDGUID (const char *guid) const
 Get fProcessGUIDs' index of the TProcessID with GUID guid. More...
 
Int_t GetInternalIdxForPID (TProcessID *procid) const
 Get the index for fProcessIDs, fAllocSize, etc given a PID. More...
 
Int_t GetInternalIdxForPID (Int_t pid) const
 Get the index for fProcessIDs, fAllocSize, etc given a PID. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

Int_tfAllocSize
 number of known ProcessIDs More...
 
Int_t fDefaultSize
 current parent ID in fParents (latest call to SetParent) More...
 
std::vector< Int_tfMapPIDtoInternal
 
Int_tfN
 [fNumPIDs] allocated size of array fParentIDs for each ProcessID More...
 
Int_t fNumPIDs
 
TObjectfOwner
 
Int_t fParentID
 [fNumPIDs][fAllocSize] array of Parent IDs More...
 
Int_t ** fParentIDs
 [fNumPIDs] current maximum number of IDs in array fParentIDs for each ProcessID More...
 
TObjArrayfParents
 
std::vector< std::string > fProcessGUIDs
 
Int_t fSize
 TProcessID the current uid is referring to. More...
 
UInt_t fUID
 default size for a new PID array More...
 
TProcessIDfUIDContext
 Current uid (set by TRef::GetObject) More...
 

Static Protected Attributes

static TRefTablefgRefTable = 0
 cache of pid to index in fProcessGUIDs More...
 

#include <TRefTable.h>

Inheritance diagram for TRefTable:
[legend]

Member Enumeration Documentation

Enumerator
kHaveWarnedReadingOld 

Definition at line 62 of file TRefTable.h.

Constructor & Destructor Documentation

TRefTable::TRefTable ( )

Default constructor for I/O.

Definition at line 52 of file TRefTable.cxx.

TRefTable::TRefTable ( TObject owner,
Int_t  size 
)

Create a TRefTable with initial size.

Definition at line 61 of file TRefTable.cxx.

TRefTable::~TRefTable ( )
virtual

Destructor.

Definition at line 71 of file TRefTable.cxx.

Member Function Documentation

Int_t TRefTable::Add ( Int_t  uid,
TProcessID context = 0 
)
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.

Int_t TRefTable::AddInternalIdxForPID ( TProcessID procid)
protected

Add the internal index for fProcessIDs, fAllocSize, etc given a PID.

Definition at line 119 of file TRefTable.cxx.

void TRefTable::Clear ( Option_t = "")
virtual

Clear all entries in the table.

Reimplemented from TObject.

Definition at line 145 of file TRefTable.cxx.

Int_t TRefTable::Expand ( Int_t  pid,
Int_t  newsize 
)
virtual

Expand fParentIDs to newsize for ProcessID pid.

Definition at line 157 of file TRefTable.cxx.

Int_t TRefTable::ExpandForIID ( Int_t  iid,
Int_t  newsize 
)
protectedvirtual

Expand fParentIDs to newsize for internel ProcessID index iid.

Definition at line 167 of file TRefTable.cxx.

void TRefTable::ExpandPIDs ( Int_t  numpids)
protected

Expand the arrays of managed PIDs.

Definition at line 193 of file TRefTable.cxx.

void TRefTable::FillBuffer ( TBuffer b)
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.

Int_t TRefTable::FindPIDGUID ( const char *  guid) const
protected

Get fProcessGUIDs' index of the TProcessID with GUID guid.

Definition at line 238 of file TRefTable.cxx.

Int_t TRefTable::GetInternalIdxForPID ( TProcessID procid) const
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.

Int_t TRefTable::GetInternalIdxForPID ( Int_t  pid) const
protected

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.

Int_t TRefTable::GetN ( Int_t  pid) const
inline

Definition at line 76 of file TRefTable.h.

Int_t TRefTable::GetNumPIDs ( ) const
inline

Definition at line 74 of file TRefTable.h.

TObject* TRefTable::GetOwner ( ) const
inline

Definition at line 77 of file TRefTable.h.

TObject * TRefTable::GetParent ( Int_t  uid,
TProcessID context = 0 
) const

Return object corresponding to uid.

Definition at line 249 of file TRefTable.cxx.

TObjArray* TRefTable::GetParents ( ) const
inline

Definition at line 79 of file TRefTable.h.

TRefTable * TRefTable::GetRefTable ( )
static

Static function returning the current TRefTable.

Definition at line 287 of file TRefTable.cxx.

Int_t TRefTable::GetSize ( Int_t  pid) const
inline

Definition at line 75 of file TRefTable.h.

UInt_t TRefTable::GetUID ( ) const
inline

Definition at line 80 of file TRefTable.h.

TProcessID* TRefTable::GetUIDContext ( ) const
inline

Definition at line 81 of file TRefTable.h.

Bool_t TRefTable::Notify ( )
virtual

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.

void TRefTable::ReadBuffer ( TBuffer b)
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.

void TRefTable::Reset ( Option_t = "")
virtual

Clear all entries in the table.

Definition at line 345 of file TRefTable.cxx.

Int_t TRefTable::SetParent ( const TObject parent,
Int_t  branchID 
)
virtual

– 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.

void TRefTable::SetRefTable ( TRefTable table)
static

Static function setting the current TRefTable.

Definition at line 383 of file TRefTable.cxx.

virtual void TRefTable::SetUID ( UInt_t  uid,
TProcessID context = 0 
)
inlinevirtual

Definition at line 87 of file TRefTable.h.

Member Data Documentation

Int_t* TRefTable::fAllocSize
protected

number of known ProcessIDs

Definition at line 39 of file TRefTable.h.

Int_t TRefTable::fDefaultSize
protected

current parent ID in fParents (latest call to SetParent)

Definition at line 43 of file TRefTable.h.

TRefTable * TRefTable::fgRefTable = 0
staticprotected

cache of pid to index in fProcessGUIDs

Definition at line 51 of file TRefTable.h.

std::vector<Int_t> TRefTable::fMapPIDtoInternal
protected

Definition at line 50 of file TRefTable.h.

Int_t* TRefTable::fN
protected

[fNumPIDs] allocated size of array fParentIDs for each ProcessID

Definition at line 40 of file TRefTable.h.

Int_t TRefTable::fNumPIDs
protected

Definition at line 38 of file TRefTable.h.

TObject* TRefTable::fOwner
protected

Definition at line 48 of file TRefTable.h.

Int_t TRefTable::fParentID
protected

[fNumPIDs][fAllocSize] array of Parent IDs

Definition at line 42 of file TRefTable.h.

Int_t** TRefTable::fParentIDs
protected

[fNumPIDs] current maximum number of IDs in array fParentIDs for each ProcessID

Definition at line 41 of file TRefTable.h.

TObjArray* TRefTable::fParents
protected

Definition at line 47 of file TRefTable.h.

std::vector<std::string> TRefTable::fProcessGUIDs
protected

Definition at line 49 of file TRefTable.h.

Int_t TRefTable::fSize
protected

TProcessID the current uid is referring to.

Definition at line 46 of file TRefTable.h.

UInt_t TRefTable::fUID
protected

default size for a new PID array

Definition at line 44 of file TRefTable.h.

TProcessID* TRefTable::fUIDContext
protected

Current uid (set by TRef::GetObject)

Definition at line 45 of file TRefTable.h.

Libraries for TRefTable:
[legend]

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