ROOT 6.14/05 Reference Guide |
A TProcessID identifies a ROOT job in a unique way in time and space.
The TProcessID title consists of a TUUID object which provides a globally unique identifier (for more see TUUID.h).
A TProcessID is automatically created by the TROOT constructor. When a TFile contains referenced objects (see TRef), the TProcessID object is written to the file. If a file has been written in multiple sessions (same machine or not), a TProcessID is written for each session. These objects are used by the class TRef to uniquely identified any TObject pointed by a TRef.
When a referenced object is read from a file (its bit kIsReferenced is set), this object is entered into the objects table of the corresponding TProcessID. Each TFile has a list of TProcessIDs (see TFile::fProcessIDs) also accessible via TProcessID::fgPIDs (for all files). When this object is deleted, it is removed from the table via the cleanup mechanism invoked by the TObject destructor.
Each TProcessID has a table (TObjArray *fObjects) that keeps track of all referenced objects. If a referenced object has a fUniqueID set, a pointer to this unique object may be found via fObjects->At(fUniqueID). In the same way, when a TRef::GetObject is called, GetObject uses its own fUniqueID to find the pointer to the referenced object. See TProcessID::GetObjectWithID and PutObjectWithID.
When a referenced object is deleted, its slot in fObjects is set to null.
See also TProcessUUID: a specialized TProcessID to manage the single list of TUUIDs.
Definition at line 69 of file TProcessID.h.
Public Member Functions | |
TProcessID () | |
Default constructor. More... | |
virtual | ~TProcessID () |
Destructor. More... | |
void | CheckInit () |
Initialize fObjects. More... | |
virtual void | Clear (Option_t *option="") |
delete the TObjArray pointing to referenced objects this function is called by TFile::Close("R") More... | |
Int_t | DecrementCount () |
The reference fCount is used to delete the TProcessID in the TFile destructor when fCount = 0. More... | |
Int_t | GetCount () const |
TObjArray * | GetObjects () const |
TObject * | GetObjectWithID (UInt_t uid) |
returns the TObject with unique identifier uid in the table of objects More... | |
Int_t | IncrementCount () |
Increase the reference count to this object. More... | |
void | PutObjectWithID (TObject *obj, UInt_t uid=0) |
stores the object at the uid th slot in the table of objects The object uniqued is set as well as its kMustCleanup bit More... | |
virtual void | RecursiveRemove (TObject *obj) |
called by the object destructor remove reference to obj from the current table if it is referenced More... | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TString &name, const TString &title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. More... | |
virtual | ~TNamed () |
TNamed destructor. More... | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. More... | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. More... | |
virtual void | Copy (TObject &named) const |
Copy this to obj. More... | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. More... | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. More... | |
virtual void | Print (Option_t *option="") const |
Print TNamed name and title. More... | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. More... | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). More... | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. More... | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. More... | |
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 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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () 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 char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
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... | |
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 |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
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... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. 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... | |
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. 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... | |
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 TProcessID * | AddProcessID () |
Static function to add a new TProcessID to the list of PIDs. More... | |
static UInt_t | AssignID (TObject *obj) |
static function returning the ID assigned to obj If the object is not yet referenced, its kIsReferenced bit is set and its fUniqueID set to the current number of referenced objects so far. More... | |
static void | Cleanup () |
static function (called by TROOT destructor) to delete all TProcessIDs More... | |
static UInt_t | GetNProcessIDs () |
Return the (static) number of process IDs. More... | |
static UInt_t | GetObjectCount () |
Return the current referenced object count fgNumber is incremented every time a new object is referenced. More... | |
static TProcessID * | GetPID () |
static: returns pointer to current TProcessID More... | |
static TObjArray * | GetPIDs () |
static: returns array of TProcessIDs More... | |
static TProcessID * | GetProcessID (UShort_t pid) |
static function returning a pointer to TProcessID number pid in fgPIDs More... | |
static TProcessID * | GetProcessWithUID (const TObject *obj) |
static function returning a pointer to TProcessID with its pid encoded in the highest byte of obj->GetUniqueID() More... | |
static TProcessID * | GetProcessWithUID (UInt_t uid, const void *obj) |
static function returning a pointer to TProcessID with its pid encoded in the highest byte of uid More... | |
static TProcessID * | GetSessionProcessID () |
static function returning the pointer to the session TProcessID More... | |
static Bool_t | IsValid (TProcessID *pid) |
static function. return kTRUE if pid is a valid TProcessID More... | |
static void | SetObjectCount (UInt_t number) |
static function to set the current referenced object count fgNumber is incremented every time a new object is referenced 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 Attributes | |
std::atomic_int | fCount |
std::atomic_flag | fLock |
Array pointing to the referenced objects. More... | |
ROOT::Internal::TAtomicPointer< TObjArray * > | fObjects |
Reference count to this object (from TFile) More... | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Static Protected Attributes | |
static std::atomic_uint | fgNumber |
static TExMap * | fgObjPIDs = 0 |
static TProcessID * | fgPID = 0 |
Spin lock for initialization of fObjects. More... | |
static TObjArray * | fgPIDs = 0 |
Private Member Functions | |
TProcessID (const TProcessID &ref) | |
TProcessID & | operator= (const TProcessID &ref) |
Additional Inherited Members | |
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) } |
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 () |
#include <TProcessID.h>
|
private |
TProcessID::TProcessID | ( | ) |
Default constructor.
Definition at line 75 of file TProcessID.cxx.
|
virtual |
Destructor.
Definition at line 93 of file TProcessID.cxx.
|
static |
Static function to add a new TProcessID to the list of PIDs.
Definition at line 114 of file TProcessID.cxx.
static function returning the ID assigned to obj If the object is not yet referenced, its kIsReferenced bit is set and its fUniqueID set to the current number of referenced objects so far.
Definition at line 153 of file TProcessID.cxx.
void TProcessID::CheckInit | ( | ) |
Initialize fObjects.
Definition at line 190 of file TProcessID.cxx.
|
static |
static function (called by TROOT destructor) to delete all TProcessIDs
Definition at line 202 of file TProcessID.cxx.
delete the TObjArray pointing to referenced objects this function is called by TFile::Close("R")
Reimplemented from TNamed.
Definition at line 216 of file TProcessID.cxx.
Int_t TProcessID::DecrementCount | ( | ) |
The reference fCount is used to delete the TProcessID in the TFile destructor when fCount = 0.
Definition at line 236 of file TProcessID.cxx.
|
inline |
Definition at line 93 of file TProcessID.h.
|
static |
Return the (static) number of process IDs.
Definition at line 254 of file TProcessID.cxx.
|
static |
Return the current referenced object count fgNumber is incremented every time a new object is referenced.
Definition at line 322 of file TProcessID.cxx.
|
inline |
Definition at line 94 of file TProcessID.h.
returns the TObject with unique identifier uid in the table of objects
Definition at line 330 of file TProcessID.cxx.
|
static |
static: returns pointer to current TProcessID
Definition at line 341 of file TProcessID.cxx.
|
static |
static: returns array of TProcessIDs
Definition at line 349 of file TProcessID.cxx.
|
static |
static function returning a pointer to TProcessID number pid in fgPIDs
Definition at line 246 of file TProcessID.cxx.
|
static |
static function returning a pointer to TProcessID with its pid encoded in the highest byte of obj->GetUniqueID()
Definition at line 295 of file TProcessID.cxx.
|
static |
static function returning a pointer to TProcessID with its pid encoded in the highest byte of uid
Definition at line 263 of file TProcessID.cxx.
|
static |
static function returning the pointer to the session TProcessID
Definition at line 303 of file TProcessID.cxx.
Int_t TProcessID::IncrementCount | ( | ) |
Increase the reference count to this object.
Definition at line 311 of file TProcessID.cxx.
|
static |
static function. return kTRUE if pid is a valid TProcessID
Definition at line 358 of file TProcessID.cxx.
|
private |
stores the object at the uid th slot in the table of objects The object uniqued is set as well as its kMustCleanup bit
Definition at line 381 of file TProcessID.cxx.
called by the object destructor remove reference to obj from the current table if it is referenced
Reimplemented from TObject.
Definition at line 410 of file TProcessID.cxx.
static function to set the current referenced object count fgNumber is incremented every time a new object is referenced
Definition at line 430 of file TProcessID.cxx.
|
protected |
Definition at line 76 of file TProcessID.h.
|
staticprotected |
Definition at line 84 of file TProcessID.h.
|
staticprotected |
Definition at line 82 of file TProcessID.h.
|
staticprotected |
Spin lock for initialization of fObjects.
Definition at line 80 of file TProcessID.h.
|
staticprotected |
Definition at line 81 of file TProcessID.h.
|
protected |
Array pointing to the referenced objects.
Definition at line 78 of file TProcessID.h.
|
protected |
Reference count to this object (from TFile)
Definition at line 77 of file TProcessID.h.