An array of references to TObjects.
The array expands automatically when objects are added (shrinking can be done by hand using Expand() )
The TRefArray can be filled with:
The array elements can be retrieved with:
By default the TRefArray 'points' to the current process and can only receive object that have been created in this process. To point the TRefArray to a different process do:
For example, if 'obj' is an instance that was created in the different process and you do:
Then
is correct (obj comes from the process the array is pointed to while
is incorrect since 'nobj' was created in a different process than the one the array is pointed to. In this case you will see error message:
When a TRefArray is Streamed, only the pointer unique id is written, not the referenced object. TRefArray may be assigned to different branches of one Tree or several Trees. The branch containing the TRefArray can be read before or after the array (eg TClonesArray, STL vector,..) of the referenced objects.
See an example in $ROOTSYS/test/Event.h
Use an array of TRef when one of the above restrictions is met.
The number of TRef handled by a single process id is limited to 16777215 (see TRef for more detail). When the TProcessID is full (has seen 16777215 objects), we switch to new one TProcessID maximum 65535 including the TProcessIDs read from file). However TRefArray can not switch to new TProcessID if they already contain objects.
When the TProcessID has been switched due to overflow and an new object is added to an existing, empty TRefArray, you will see:
If the TRefArray was not empty, you will see:
When running out of TProcessIds, you will see:
Definition at line 33 of file TRefArray.h.
Public Types | |
typedef TRefArrayIter | Iterator_t |
![]() | |
enum | { kInitCapacity = 16 , kInitHashTableCapacity = 17 } |
![]() | |
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 | |
TRefArray (const TRefArray &a) | |
Create a copy of TRefArray a. | |
TRefArray (Int_t s, Int_t lowerBound=0, TProcessID *pid=0) | |
Create an object array. | |
TRefArray (Int_t s, TProcessID *pid) | |
Create an object array. | |
TRefArray (TProcessID *pid=0) | |
default constructor | |
virtual | ~TRefArray () |
Usual destructor (The object pointed to by the array are never deleted). | |
void | Add (TObject *obj) |
virtual void | AddAfter (const TObject *after, TObject *obj) |
Add object in the slot after object after. | |
virtual void | AddAt (TObject *obj, Int_t idx) |
Add object at position ids. | |
virtual void | AddAtAndExpand (TObject *obj, Int_t idx) |
Add object at position idx. | |
virtual Int_t | AddAtFree (TObject *obj) |
Return the position of the new object. | |
virtual void | AddBefore (const TObject *before, TObject *obj) |
Add object in the slot before object before. | |
virtual void | AddFirst (TObject *obj) |
Add object in the first slot of the array. | |
virtual void | AddLast (TObject *obj) |
Add object in the next empty slot in the array. | |
TObject * | After (const TObject *obj) const |
Return the object after obj. Returns 0 if obj is last object. | |
TObject * | At (Int_t idx) const |
TObject * | Before (const TObject *obj) const |
Return the object before obj. Returns 0 if obj is first object. | |
virtual Int_t | BinarySearch (TObject *obj, Int_t upto=kMaxInt) |
Find object using a binary search. | |
virtual void | Clear (Option_t *option="") |
Remove all objects from the array. | |
virtual void | Compress () |
Remove empty slots from array. | |
virtual void | Delete (Option_t *option="") |
Remove all objects from the array and free the internal memory. | |
virtual void | Expand (Int_t newSize) |
Expand or shrink the array to newSize elements. | |
TObject * | First () const |
Return the object in the first slot. | |
Int_t | GetEntries () const |
Return the number of objects in array (i.e. | |
Int_t | GetEntriesFast () const |
Int_t | GetLast () const |
Return index of last object in array. | |
TObject ** | GetObjectRef (const TObject *obj) const |
Return address of pointer obj. | |
TProcessID * | GetPID () const |
UInt_t | GetUID (Int_t at) const |
Return UID of element at. | |
Int_t | IndexOf (const TObject *obj) const |
Bool_t | IsEmpty () const |
TObject * | Last () const |
Return the object in the last filled slot. Returns 0 if no entries. | |
Int_t | LowerBound () const |
TIterator * | MakeIterator (Bool_t dir=kIterForward) const |
Returns an array iterator. | |
TRefArray & | operator= (const TRefArray &a) |
Assignment operator. | |
virtual TObject * | operator[] (Int_t i) const |
virtual TObject * | Remove (TObject *obj) |
Remove object from array. | |
virtual TObject * | RemoveAt (Int_t idx) |
Remove object at index idx. | |
void | SetLast (Int_t last) |
Set index of last object in array, effectively truncating the array. | |
virtual void | Sort (Int_t upto=kMaxInt) |
If objects in array are sortable (i.e. | |
![]() | |
virtual | ~TSeqCollection () |
virtual Bool_t | IsSorted () const |
Int_t | LastIndex () const |
Long64_t | Merge (TCollection *list) |
Merge this collection with all collections coming in the input list. | |
virtual void | RemoveAfter (TObject *after) |
virtual void | RemoveBefore (TObject *before) |
virtual void | RemoveFirst () |
virtual void | RemoveLast () |
void | UnSort () |
![]() | |
virtual | ~TCollection () |
TNamed destructor. | |
virtual void | AddAll (const TCollection *col) |
Add all objects from collection col to this collection. | |
void | AddVector (TObject *obj1,...) |
Add all arguments to the collection. | |
Bool_t | AssertClass (TClass *cl) const |
Make sure all objects in this collection inherit from class cl. | |
TIter | begin () const |
void | Browse (TBrowser *b) |
Browse this collection (called by TBrowser). | |
Int_t | Capacity () const |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an collection using the Streamer facility. | |
Int_t | Compare (const TObject *obj) const |
Compare two TCollection objects. | |
Bool_t | Contains (const char *name) const |
Bool_t | Contains (const TObject *obj) const |
virtual void | Draw (Option_t *option="") |
Draw all objects in this collection. | |
virtual void | Dump () const |
Dump all objects in this collection. | |
TIter | end () const |
virtual TObject * | FindObject (const char *name) const |
Find an object in this collection using its name. | |
virtual TObject * | FindObject (const TObject *obj) const |
Find an object in this collection using the object's IsEqual() member function. | |
virtual const char * | GetName () const |
Return name of this collection. | |
virtual Int_t | GetSize () const |
Return the capacity of the collection, i.e. | |
virtual Int_t | GrowBy (Int_t delta) const |
Increase the collection's capacity by delta slots. | |
ULong_t | Hash () const |
Return hash value for this object. | |
Bool_t | IsArgNull (const char *where, const TObject *obj) const |
Returns true if object is a null pointer. | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
Bool_t | IsOwner () const |
Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsUsingRWLock () const |
virtual void | ls (Option_t *option="") const |
List (ls) all objects in this collection. | |
virtual TIterator * | MakeReverseIterator () const |
virtual Bool_t | Notify () |
'Notify' all objects in this collection. | |
TObject * | operator() (const char *name) const |
Find an object in this collection by name. | |
virtual void | Paint (Option_t *option="") |
Paint all objects in this collection. | |
virtual void | Print (Option_t *option, const char *wildcard, Int_t recurse=1) const |
Print the collection header and its elements that match the wildcard. | |
virtual void | Print (Option_t *option, Int_t recurse) const |
Print the collection header and its elements. | |
virtual void | Print (Option_t *option, TPRegexp ®exp, Int_t recurse=1) const |
Print the collection header and its elements that match the regexp. | |
virtual void | Print (Option_t *option="") const |
Default print for collections, calls Print(option, 1). | |
virtual void | RecursiveRemove (TObject *obj) |
Remove object from this collection and recursively remove the object from all other objects (and collections). | |
void | RemoveAll () |
virtual void | RemoveAll (TCollection *col) |
Remove all objects in collection col from this collection. | |
void | SetCurrentCollection () |
Set this collection to be the globally accessible collection. | |
void | SetName (const char *name) |
virtual void | SetOwner (Bool_t enable=kTRUE) |
Set whether this collection is the owner (enable==true) of its content. | |
virtual bool | UseRWLock (Bool_t enable=true) |
Set this collection to use a RW lock upon access, making it thread safe. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write all objects in this collection. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write all objects in this collection. | |
![]() | |
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. | |
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 | Copy (TObject &object) const |
Copy this to obj. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
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 for instance with: gROOT->SetSelectedPad(gPad) . | |
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=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
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 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 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. | |
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). | |
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). | |
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) |
Operator delete []. | |
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 | 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. | |
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. | |
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. | |
Protected Member Functions | |
Bool_t | BoundsOk (const char *where, Int_t at) const |
Int_t | GetAbsLast () const |
Return absolute index to last object in array. | |
TObject * | GetFromTable (Int_t idx) const |
the reference may be in the TRefTable | |
Bool_t | GetObjectUID (Int_t &uid, TObject *obj, const char *methodname) |
Private/static function, check for validity of pid. | |
void | Init (Int_t s, Int_t lowerBound) |
Initialize a TRefArray. | |
Bool_t | OutOfBoundsError (const char *where, Int_t i) const |
Generate an out-of-bounds error. Always returns false. | |
![]() | |
TSeqCollection () | |
virtual void | Changed () |
![]() | |
TCollection () | |
virtual const char * | GetCollectionEntryName (TObject *entry) const |
For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on. | |
virtual void | PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const |
Print the collection entry. | |
virtual void | PrintCollectionHeader (Option_t *option) const |
Print the collection header. | |
![]() | |
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 | fLast |
Int_t | fLowerBound |
TProcessID * | fPID |
UInt_t * | fUIDs |
![]() | |
Bool_t | fSorted |
![]() | |
TString | fName |
Int_t | fSize |
Friends | |
class | TRefArrayIter |
Additional Inherited Members | |
![]() | |
static Int_t | ObjCompare (TObject *a, TObject *b) |
Compare to objects in the collection. Use member Compare() of object a. | |
static void | QSort (TObject **a, Int_t first, Int_t last) |
Sort array of TObject pointers using a quicksort algorithm. | |
static void | QSort (TObject **a, Int_t nBs, TObject ***b, Int_t first, Int_t last) |
Sort array a of TObject pointers using a quicksort algorithm. | |
static void | QSort (TObject **a, TObject **b, Int_t first, Int_t last) |
![]() | |
static void | EmptyGarbageCollection () |
Do the garbage collection. | |
static void | GarbageCollect (TObject *obj) |
Add to the list of things to be cleaned up. | |
static TCollection * | GetCurrentCollection () |
Return the globally accessible collection. | |
static void | StartGarbageCollection () |
Set up for garbage collection. | |
![]() | |
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. | |
![]() | |
enum | EStatusBits { kIsOwner = BIT(14) , kUseRWLock = BIT(16) } |
![]() | |
enum | { kOnlyPrepStep = BIT(3) } |
#include <TRefArray.h>
typedef TRefArrayIter TRefArray::Iterator_t |
Definition at line 51 of file TRefArray.h.
TRefArray::TRefArray | ( | TProcessID * | pid = 0 | ) |
default constructor
Definition at line 109 of file TRefArray.cxx.
TRefArray::TRefArray | ( | Int_t | s, |
TProcessID * | pid | ||
) |
Create an object array.
Using s one can set the array size and lowerBound can be used to set the array lowerbound index (default is 0).
Definition at line 124 of file TRefArray.cxx.
TRefArray::TRefArray | ( | Int_t | s, |
Int_t | lowerBound = 0 , |
||
TProcessID * | pid = 0 |
||
) |
Create an object array.
Using s one can set the array size and lowerBound can be used to set the array lowerbound index (default is 0).
Definition at line 141 of file TRefArray.cxx.
TRefArray::TRefArray | ( | const TRefArray & | a | ) |
Create a copy of TRefArray a.
Definition at line 156 of file TRefArray.cxx.
|
virtual |
Usual destructor (The object pointed to by the array are never deleted).
Definition at line 196 of file TRefArray.cxx.
Reimplemented from TSeqCollection.
Definition at line 74 of file TRefArray.h.
Add object in the slot after object after.
If after=0 add object in the last empty slot. Note that this will overwrite any object that might have already been in this slot. For insertion semantics use either a TList or a TOrdCollection.
Implements TSeqCollection.
Definition at line 317 of file TRefArray.cxx.
Add object at position ids.
Give an error when idx is out of bounds (i.e. the array is not expanded).
Implements TSeqCollection.
Definition at line 358 of file TRefArray.cxx.
Add object at position idx.
If idx is larger than the current size of the array, expand the array (double its size).
Definition at line 335 of file TRefArray.cxx.
Return the position of the new object.
Find the first empty cell or AddLast if there is no empty cell
Definition at line 376 of file TRefArray.cxx.
Add object in the slot before object before.
If before=0 add object in the first slot. Note that this will overwrite any object that might have already been in this slot. For insertion semantics use either a TList or a TOrdCollection.
Implements TSeqCollection.
Definition at line 293 of file TRefArray.cxx.
Add object in the first slot of the array.
This will overwrite the first element that might have been there. To have insertion semantics use either a TList or a TOrdCollection.
Implements TSeqCollection.
Definition at line 266 of file TRefArray.cxx.
Add object in the next empty slot in the array.
Expand the array if necessary.
Implements TSeqCollection.
Definition at line 282 of file TRefArray.cxx.
Return the object after obj. Returns 0 if obj is last object.
Implements TSeqCollection.
Definition at line 400 of file TRefArray.cxx.
Implements TSeqCollection.
Definition at line 178 of file TRefArray.h.
Return the object before obj. Returns 0 if obj is first object.
Implements TSeqCollection.
Definition at line 413 of file TRefArray.cxx.
Find object using a binary search.
Array must first have been sorted. Search can be limited by setting upto to desired index.
Definition at line 810 of file TRefArray.cxx.
Definition at line 157 of file TRefArray.h.
Remove all objects from the array.
Implements TCollection.
Definition at line 426 of file TRefArray.cxx.
|
virtual |
Remove empty slots from array.
Definition at line 438 of file TRefArray.cxx.
Remove all objects from the array and free the internal memory.
Implements TCollection.
Definition at line 457 of file TRefArray.cxx.
Expand or shrink the array to newSize elements.
Definition at line 473 of file TRefArray.cxx.
|
virtual |
Return the object in the first slot.
Implements TSeqCollection.
Definition at line 568 of file TRefArray.cxx.
|
protected |
Return absolute index to last object in array.
Returns -1 in case array is empty.
Definition at line 605 of file TRefArray.cxx.
|
virtual |
Return the number of objects in array (i.e.
number of non-empty slots). Attention: use this method ONLY if you want to know the number of non-empty slots. This function loops over the complete array and is therefore very slow when applied in a loop. Most of the time you better use GetLast()+1.
Reimplemented from TCollection.
Definition at line 591 of file TRefArray.cxx.
|
inline |
Definition at line 64 of file TRefArray.h.
the reference may be in the TRefTable
Definition at line 501 of file TRefArray.cxx.
|
virtual |
Return index of last object in array.
Returns lowerBound-1 in case array is empty.
Reimplemented from TSeqCollection.
Definition at line 625 of file TRefArray.cxx.
Return address of pointer obj.
Implements TCollection.
Definition at line 633 of file TRefArray.cxx.
Private/static function, check for validity of pid.
Definition at line 207 of file TRefArray.cxx.
|
inline |
Definition at line 69 of file TRefArray.h.
Return UID of element at.
Definition at line 643 of file TRefArray.cxx.
Reimplemented from TSeqCollection.
Definition at line 661 of file TRefArray.cxx.
Initialize a TRefArray.
Definition at line 683 of file TRefArray.cxx.
|
inlinevirtual |
Reimplemented from TCollection.
Definition at line 71 of file TRefArray.h.
|
virtual |
Return the object in the last filled slot. Returns 0 if no entries.
Implements TSeqCollection.
Definition at line 576 of file TRefArray.cxx.
|
inline |
Definition at line 91 of file TRefArray.h.
|
virtual |
Assignment operator.
Definition at line 172 of file TRefArray.cxx.
Definition at line 164 of file TRefArray.h.
Generate an out-of-bounds error. Always returns false.
Definition at line 714 of file TRefArray.cxx.
Remove object at index idx.
Reimplemented from TSeqCollection.
Definition at line 723 of file TRefArray.cxx.
Set index of last object in array, effectively truncating the array.
Use carefully since whenever last position has to be recalculated, e.g. after a Remove() or Sort() it will be reset to the last non-empty slot. If last is -2 this will force the recalculation of the last used slot.
Definition at line 774 of file TRefArray.cxx.
If objects in array are sortable (i.e.
IsSortable() returns true for all objects) then sort array.
Definition at line 786 of file TRefArray.cxx.
|
friend |
Definition at line 35 of file TRefArray.h.
|
protected |
Definition at line 41 of file TRefArray.h.
|
protected |
Definition at line 40 of file TRefArray.h.
|
protected |
Definition at line 38 of file TRefArray.h.
|
protected |
Definition at line 39 of file TRefArray.h.