ROOT logo

class TRef: public TObject


 Persistent Reference link to a TObject
 A TRef is a lightweight object pointing to any TObject.
 This object can be used instead of normal C++ pointers in case
  - the referenced object R and the pointer P are not written to the same file
  - P is read before R
  - R and P are written to different Tree branches

 When a top level object (eg Event *event) is a tree/graph of many objects,
 the normal ROOT Streaming mechanism ensures that only one copy of each object
 in the tree/graph is written to the output buffer to avoid circular
 However if the object event is split into several files or into several
 branches of one or more Trees, normal C++ pointers cannot be used because
 each I/O operation will write the referenced objects.
 When a TRef is used to point to a TObject *robj, for example in a class with
     TRef  fRef;
 one can do:
     fRef = robj;  //to set the pointer
 This TRef and robj can be written with two different I/O calls
 in the same or different files, in the same or different branches of a Tree.

 If the TRef is read and the referenced object has not yet been read,
 the TRef will return a null pointer. As soon as the referenced object
 will be read, the TRef will point to it. If the referenced object is
 contained in a TTree it can be autoloaded using the TBranchRef mechanism,
 which is set up by simply calling TTree::BranchRef().

 TRef also supports the complex situation where a TFile is updated
 multiple times on the same machine or a different machine.

 How does it work

 A TRef is itself a TObject with an additional transient pointer fPID.
 When the statement fRef = robj is executed, the following actions happen:
   - The pointer fPID is set to the current TProcessID.
   - The current ObjectNumber (see below) is incremented by one.
   - robj::fUniqueID is set to ObjectNumber.
   - In the fPID object, the element fObjects[ObjectNumber] is set to robj
   - ref::fUniqueID is also set to ObjectNumber.
 After having set fRef, one can immediatly return the value of robj
 using fRef.GetObject(). This function returns directly fObjects[fUniqueID]
 from the fPID object.

 When the TRef is written, the process id number pidf of fPID is written
 in addition to the TObject part of TRef (fBits,fUniqueID).
 When the TRef is read, its pointer fPID is set to the value
 stored in the TObjArray of TFile::fProcessIDs (fProcessIDs[pidf]).
 The pidf is stored in the bits 24->31 of the fUniqueID of the TRef.
 This implies that the number of TRefs in one process should not
 exceed 2**23 = 8388608 and that the number of processes (different jobs)
 writing TRefs to one file should be less than 256.
 See section "ObjectNumber" below for a recipee to minimize the object count.
 If the objectnumber exceeds this limit, it could be the sign that:
   -The object count is never reset (see below)
   -TRef is misused.

 When a referenced object robj is written, TObject::Streamer writes
 in addition to the standard (fBits,fUniqueID) the pidf.
 When this robj is read by TObject::Streamer, the pidf is read.
 At this point, robj is entered into the table of objects of the TProcessID
 corresponding to pidf.

 WARNING1: If MyClass is the class of the referenced object, The TObject
          part of MyClass must be Streamed. One should not
          call MyClass::Class()->IgnoreTObjectStreamer()

 WARNING2: A TRef cannot point to another TRef.


 When an object is referenced (see TRef assignement operator or TRefArray::Add)
 a unique identifier is computed and stored in both the fUniqueID of the
 referenced and referencing object. This uniqueID is computed by incrementing
 by one the static global in TProcessID::fgNumber. fUniqueID is some sort of
 serial object number in the current session. One can retrieve at any time
 the current value of fgNumber by calling the static function TProcessID::GetObjectCount
 or set this number via TProcessID::SetObjectCount.
 To avoid a growing table of fObjects in TProcessID, in case, for example,
 one processes many events in a loop, it might be necessary to reset the
 ObjectNumber at the end of processing of one event. See an example
 in $ROOTSYS/test/Event.cxx (look at function Build).
 The value of ObjectNumber (say saveNumber=TProcessID::GetObjectCount()) may be
 saved at the beginning of one event and reset to this original value
 at the end of the event via TProcessID::SetObjectCount(saveNumber). These
 actions may be stacked.

 Action on Demand

 The normal behaviour of a TRef has been described above. In addition,
 TRef supports also "Actions on Demand". It may happen that the object
 referenced is not yet in memory, on a separate file or not yet computed.
 In this case TRef is able to automatically execute an action:
   - call to a compiled function (static function of member function)
   - call to an interpreted function
   - execution of a CINT script

 How to select this option?
 In the definition of the TRef data member in the original class, do:
   TRef  fRef;   //EXEC:execName. points to something
 When the special keyword "EXEC:" is found in the comment field of the member,
 the next string is assumed to be the name of a TExec object.
 When a file is connected, the dictionary of the classes on the file
 is read in memory (see TFile::ReadStreamerInfo). When the TStreamerElement
 object is read, a TExec object is automatically created with the name
 specified after the keywork "EXEC:" in case a TExec with a same name does
 not already exist.
 The action to be executed via this TExec can be specified with:
    - a call to the TExec constructor, if the constructor is called before
      opening the file.
    - a call to TExec::SetAction at any time.
      One can compute a pointer to an existing TExec with a name with:
        TExec *myExec = gROOT->GetExec(execName);
      myExec->SetAction(actionCommand); where
      - actionCommand is a string containing a CINT instruction. Examples:
          myExec->SetAction(".x script.C");

 When a TRef is dereferenced via TRef::GetObject, its TExec will be
 automatically executed. In the function/script being executed, one or more
 of the following actions can be executed:
  - load a file containing the referenced object. This function typically
    looks in the file catalog (GRID).
  - compute a pointer to the referenced object and communicate this pointer
    back to the calling function TRef::GetObject via:
    When the TExec is called, it has access to the dereferencing TRef
    by calling GetStaticObject() (TRef::GetObject() sets fgObject to "this"
    before the call to TExec). This can be useful for accessing the TRef's
 As soon as an object is returned to GetObject, the fUniqueID of the TRef is set
 to the fUniqueID of the referenced object. At the next call to GetObject,
 the pointer stored in fPid:fObjects[fUniqueID] will be returned directly.

 An example of action on demand is shown in $ROOTSYS/test/Event.h with
 the member:
      TRef    fWebHistogram;   //EXEC:GetWebHistogram
 When calling fWebHistogram.GetObject(), the function GetObject
 will automatically invoke a script GetWebHistogram.C via the interpreter.
 An example of a GetWebHistogram.C script is shown below
    void GetWebHistogram() {
       TFile *f= TFile::Open("");
       TH1 *h6 = (TH1*)gDirectory->Get("h6");
       delete f;
 In the above example, a call to fWebHistogram.GetObject() executes the
 script with the function GetWebHistogram. This script connects a file
 with histograms: pippa.root on the ROOT Web site and returns the object h6
 to TRef::GetObject.
 Note that if the definition of the TRef fWebHistogram had been:
      TRef    fWebHistogram;   //EXEC:GetWebHistogram()
 then, the compiled or interpreted function GetWebHistogram() would have
 been called instead of the CINT script GetWebHistogram.C

 Special case of a TRef pointing to an object with a TUUID

 If the referenced object has a TUUID, its bit kHasUUID has been set.
 This case is detected by the TRef assignement operator.
 (For example, TFile and TDirectory have a TUUID)
 The TRef fPID points directly to the single object TProcessUUID (deriving
 from TProcessID) and managing the list of TUUIDs for a process.
 The TRef kHasUUID bit is set and its fUniqueID is set to the fUniqueID
 of the referenced object.
 When the TRef is streamed to a buffer, the corresponding TUUID is also
 streamed with the TRef. When a TRef is read from a buffer, the corresponding
 TUUID is also read and entered into the global list of TUUIDs (if not
 already there). The TRef fUniqueID is set to the UUIDNumber.
 see TProcessUUID for more details.

 Array of TRef

 The special class TRefArray should be used to store multiple references.
 A TRefArray has one single pointer fPID for all objects in the array.
 It has a dynamic compact table of fUniqueIDs. Use a TRefArray rather
 then a collection of TRefs if all TRefs stem from the same process.

 Suppose a TObjArray *mytracks containing a list of Track objects
 Suppose a TRefArray *pions containing pointers to the pion tracks in mytracks.
 This list is created with statements like: pions->Add(track);
 Suppose a TRefArray *muons containing pointers to the muon tracks in mytracks.
 The 3 arrays mytracks,pions and muons may be written separately.

Function Members (Methods)

TRef(TObject* obj)
TRef(const TRef& ref)
voidTObject::AbstractMethod(const char* method) const
static Int_tAddExec(const char* name)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
static TObjArray*GetListOfExecs()
virtual const char*TObject::GetName() const
TObject*GetObject() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
TProcessID*GetPID() const
static TObject*GetStaticObject()
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tIsValid() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
voidoperator=(TObject* obj)
TRef&operator=(const TRef& ref)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTObject::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual voidSetAction(const char* name)
virtual voidSetAction(TObject* parent)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidSetObject(TObject* obj)
static voidTObject::SetObjectStat(Bool_t stat)
static voidSetStaticObject(TObject* obj)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const

Data Members

TProcessID*fPID!Pointer to ProcessID when TRef was written
static TObjArray*fgExecsList of execs
static TObject*fgObjectIn: this, Out: pointer to object (used by Action on Demand)

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TRef(TObject* obj)
 Create a ref to obj.
TRef(const TRef& ref)
 TRef copy ctor.
void operator=(TObject* obj)
 Assign object to reference.
TRef & operator=(const TRef& ref)
 TRef assignment operator.
Int_t AddExec(const char* name)
 If Exec with name does not exist in the list of Execs, it is created.
 returns the index of the Exec in the list.
TObjArray * GetListOfExecs()
 Return a pointer to the static TObjArray holding the list of Execs.
TObject * GetObject() const
 Return a pointer to the referenced object.
void SetAction(const char* name)
 Store the exec number (in the ROOT list of Execs)
 into the fBits of this TRef.
void SetAction(TObject* parent)
 Find the action to be executed in the dictionary of the parent class
 and store the corresponding exec number into fBits.
 This function searches a data member in the class of parent with an
 offset corresponding to this.
 If a comment "TEXEC:" is found in the comment field of the data member,
 the function stores the exec identifier of the exec statement
 following this keyword.
TObject * GetStaticObject()
 Returns the static object.
void SetObject(TObject* obj)
 static Obsolete function kept for back compatibility.
 In the near future will print a Warning, then will be deleted.
void SetStaticObject(TObject* obj)
 Static function to set the object found on the Action on Demand function.
 This function may be called by the user in the function called
 when a "EXEC:" keyword is specified in the data member field of the TRef.
 The function can get access to the dereferencing TRef (i.e. this)using
 the static function GetStaticObject().
void Streamer(TBuffer& b)
 Stream an object of class TRef.
{ }
virtual ~TRef()
{ }
TProcessID * GetPID() const
{return fPID;}
Bool_t IsValid() const
{return GetUniqueID()!=0 ? kTRUE : kFALSE;}