ROOT 6.07/09 Reference Guide |
An array of TObjects.
The array expands automatically when objects are added (shrinking can be done by hand using Expand(), how nice to have meaningful names -:)). Use operator[] to have "real" array behaviour.
Note on ownership and copy: By default the TObjArray does not own the objects it points to and will not delete them unless explicitly asked (via a call to the Delete member function). To assign ownership of the content to the array, call:
When the array owns its content a call to Clear or the deletion of the array itself will lead to the deletion of its contents.
You can either make a shallow copy of the array:
in which case ownership (if any) is not transfered but the other array points to the same object as the original array. Note that if the content of either array is deleted the other array is not notified in any way (i.e. still points to the now deleted objects).
You can also make a deep copy of the array:
in which case the array and the content are both duplicated (i.e. otherarr and myarr do not point to the same objects). If myarr is set to the be the owner of its content, otherarr will also be set to the owner of its own content.
Definition at line 39 of file TObjArray.h.
Public Types | |
typedef TObjArrayIter | Iterator_t |
Public Types inherited from TCollection | |
enum | { kInitCapacity = 16, kInitHashTableCapacity = 17 } |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
Public Member Functions | |
TObjArray (Int_t s=TCollection::kInitCapacity, Int_t lowerBound=0) | |
Create an object array. More... | |
TObjArray (const TObjArray &a) | |
Create a copy of TObjArray a. Note, does not copy the kIsOwner flag. More... | |
virtual | ~TObjArray () |
Delete an array. More... | |
void | Add (TObject *obj) |
virtual void | AddAfter (const TObject *after, TObject *obj) |
Add object in the slot after object after. More... | |
virtual void | AddAt (TObject *obj, Int_t idx) |
Add object at position ids. More... | |
virtual void | AddAtAndExpand (TObject *obj, Int_t idx) |
Add object at position idx. More... | |
virtual Int_t | AddAtFree (TObject *obj) |
Return the position of the new object. More... | |
virtual void | AddBefore (const TObject *before, TObject *obj) |
Add object in the slot before object before. More... | |
virtual void | AddFirst (TObject *obj) |
Add object in the first slot of the array. More... | |
virtual void | AddLast (TObject *obj) |
Add object in the next empty slot in the array. More... | |
TObject * | After (const TObject *obj) const |
Return the object after obj. Returns 0 if obj is last object. More... | |
TObject * | At (Int_t idx) const |
TObject * | Before (const TObject *obj) const |
Return the object before obj. Returns 0 if obj is first object. More... | |
virtual Int_t | BinarySearch (TObject *obj, Int_t upto=kMaxInt) |
Find object using a binary search. More... | |
virtual void | Clear (Option_t *option="") |
Remove all objects from the array. More... | |
virtual void | Compress () |
Remove empty slots from array. More... | |
virtual void | Delete (Option_t *option="") |
Remove all objects from the array AND delete all heap based objects. More... | |
virtual void | Expand (Int_t newSize) |
Expand or shrink the array to newSize elements. More... | |
virtual TObject * | FindObject (const char *name) const |
Find an object in this collection using its name. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Find an object in this collection using the object's IsEqual() member function. More... | |
TObject * | First () const |
Return the object in the first slot. More... | |
Int_t | GetEntries () const |
Return the number of objects in array (i.e. More... | |
Int_t | GetEntriesFast () const |
Int_t | GetLast () const |
Return index of last object in array. More... | |
TObject ** | GetObjectRef () const |
TObject ** | GetObjectRef (const TObject *obj) const |
Return address of pointer obj. If obj is 0 returns address of container. More... | |
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. More... | |
Int_t | LowerBound () const |
TIterator * | MakeIterator (Bool_t dir=kIterForward) const |
Returns an array iterator. More... | |
TObjArray & | operator= (const TObjArray &) |
Assignment operator. Note, unsets the kIsOwner flag. More... | |
virtual TObject *& | operator[] (Int_t i) |
Return the object at position i. More... | |
virtual TObject * | operator[] (Int_t i) const |
Return the object at position at. Returns 0 if i is out of bounds. More... | |
virtual void | Randomize (Int_t ntimes=1) |
Randomize objects inside the array, i.e. More... | |
virtual void | RecursiveRemove (TObject *obj) |
Remove object from this collection and recursively remove the object from all other objects (and collections). More... | |
virtual TObject * | Remove (TObject *obj) |
Remove object from array. More... | |
virtual TObject * | RemoveAt (Int_t idx) |
Remove object at index idx. More... | |
virtual void | RemoveRange (Int_t idx1, Int_t idx2) |
Remove objects from index idx1 to idx2 included. More... | |
void | SetLast (Int_t last) |
Set index of last object in array, effectively truncating the array. More... | |
virtual void | Sort (Int_t upto=kMaxInt) |
If objects in array are sortable (i.e. More... | |
TObject * | UncheckedAt (Int_t i) const |
Public Member Functions inherited from TSeqCollection | |
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. More... | |
virtual void | RemoveAfter (TObject *after) |
virtual void | RemoveBefore (TObject *before) |
virtual void | RemoveFirst () |
virtual void | RemoveLast () |
void | UnSort () |
Public Member Functions inherited from TCollection | |
virtual | ~TCollection () |
virtual void | AddAll (const TCollection *col) |
Add all objects from collection col to this collection. More... | |
void | AddVector (TObject *obj1,...) |
Add all arguments to the collection. More... | |
Bool_t | AssertClass (TClass *cl) const |
Make sure all objects in this collection inherit from class cl. More... | |
TIter | begin () const |
void | Browse (TBrowser *b) |
Browse this collection (called by TBrowser). More... | |
Int_t | Capacity () const |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an collection using the Streamer facility. More... | |
Int_t | Compare (const TObject *obj) const |
Compare two TCollection objects. More... | |
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. More... | |
virtual void | Dump () const |
Dump all objects in this collection. More... | |
TIter | end () const |
virtual const char * | GetName () const |
Return name of this collection. More... | |
virtual Int_t | GetSize () const |
virtual Int_t | GrowBy (Int_t delta) const |
Increase the collection's capacity by delta slots. More... | |
ULong_t | Hash () const |
Return hash value for this object. More... | |
Bool_t | IsArgNull (const char *where, const TObject *obj) const |
Returns true if object is a null pointer. More... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
Bool_t | IsOwner () const |
Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List (ls) all objects in this collection. More... | |
virtual TIterator * | MakeReverseIterator () const |
TObject * | operator() (const char *name) const |
Find an object in this collection by name. More... | |
virtual void | Paint (Option_t *option="") |
Paint all objects in this collection. More... | |
virtual void | Print (Option_t *option="") const |
Default print for collections, calls Print(option, 1). More... | |
virtual void | Print (Option_t *option, Int_t recurse) const |
Print the collection header and its elements. More... | |
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. More... | |
virtual void | Print (Option_t *option, TPRegexp ®exp, Int_t recurse=1) const |
Print the collection header and its elements that match the regexp. More... | |
virtual void | RemoveAll (TCollection *col) |
Remove all objects in collection col from this collection. More... | |
void | RemoveAll () |
void | SetCurrentCollection () |
Set this collection to be the globally accesible collection. More... | |
void | SetName (const char *name) |
virtual void | SetOwner (Bool_t enable=kTRUE) |
Set whether this collection is the owner (enable==true) of its content. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write all objects in this collection. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write all objects in this collection. 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 const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Copy (TObject &object) const |
Copy this to obj. More... | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. 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 pad. 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 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 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 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... | |
Bool_t | IsOnHeap () const |
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 | 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... | |
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... | |
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. More... | |
void | Init (Int_t s, Int_t lowerBound) |
Initialize a TObjArray. More... | |
Bool_t | OutOfBoundsError (const char *where, Int_t i) const |
Generate an out-of-bounds error. Always returns false. More... | |
Protected Member Functions inherited from TSeqCollection | |
TSeqCollection () | |
virtual void | Changed () |
Protected Member Functions inherited from TCollection | |
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. More... | |
virtual void | PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const |
Print the collection entry. More... | |
virtual void | PrintCollectionHeader (Option_t *option) const |
Print the collection header. 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 | |
TObject ** | fCont |
Int_t | fLast |
Int_t | fLowerBound |
Array contents. More... | |
Protected Attributes inherited from TSeqCollection | |
Bool_t | fSorted |
Protected Attributes inherited from TCollection | |
TString | fName |
Int_t | fSize |
Friends | |
class | TClonesArray |
class | TObjArrayIter |
Additional Inherited Members | |
Static Public Member Functions inherited from TSeqCollection | |
static Int_t | ObjCompare (TObject *a, TObject *b) |
Compare to objects in the collection. Use member Compare() of object a. More... | |
static void | QSort (TObject **a, Int_t first, Int_t last) |
Sort array of TObject pointers using a quicksort algorithm. More... | |
static void | QSort (TObject **a, TObject **b, Int_t first, Int_t last) |
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. More... | |
Static Public Member Functions inherited from TCollection | |
static void | EmptyGarbageCollection () |
Do the garbage collection. More... | |
static void | GarbageCollect (TObject *obj) |
Add to the list of things to be cleaned up. More... | |
static TCollection * | GetCurrentCollection () |
Return the globally accessible collection. More... | |
static void | StartGarbageCollection () |
Set up for garbage collection. 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 Types inherited from TCollection | |
enum | { kIsOwner = BIT(14) } |
#include <TObjArray.h>
typedef TObjArrayIter TObjArray::Iterator_t |
Definition at line 55 of file TObjArray.h.
TObjArray::TObjArray | ( | Int_t | s = TCollection::kInitCapacity , |
Int_t | lowerBound = 0 |
||
) |
Create an object array.
Using s one can set the array size (default is kInitCapacity=16) and lowerBound can be used to set the array lowerbound index (default is 0).
Definition at line 63 of file TObjArray.cxx.
TObjArray::TObjArray | ( | const TObjArray & | a | ) |
Create a copy of TObjArray a. Note, does not copy the kIsOwner flag.
Definition at line 77 of file TObjArray.cxx.
|
virtual |
Delete an array.
Objects are not deleted unless the TObjArray is the owner (set via SetOwner()).
Definition at line 93 of file TObjArray.cxx.
Reimplemented from TSeqCollection.
Definition at line 75 of file TObjArray.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.
Reimplemented in TClonesArray.
Definition at line 204 of file TObjArray.cxx.
Add object at position ids.
Give an error when idx is out of bounds (i.e. the array is not expanded).
Implements TSeqCollection.
Reimplemented in TClonesArray.
Definition at line 239 of file TObjArray.cxx.
Add object at position idx.
If idx is larger than the current size of the array, expand the array (double its size).
Reimplemented in TClonesArray.
Definition at line 222 of file TObjArray.cxx.
Return the position of the new object.
Find the first empty cell or AddLast if there is no empty cell
Reimplemented in TClonesArray.
Definition at line 252 of file TObjArray.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.
Reimplemented in TClonesArray.
Definition at line 180 of file TObjArray.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.
Reimplemented in TClonesArray.
Definition at line 157 of file TObjArray.cxx.
Add object in the next empty slot in the array.
Expand the array if necessary.
Implements TSeqCollection.
Reimplemented in TClonesArray.
Definition at line 169 of file TObjArray.cxx.
Return the object after obj. Returns 0 if obj is last object.
Implements TSeqCollection.
Definition at line 271 of file TObjArray.cxx.
Implements TSeqCollection.
Definition at line 167 of file TObjArray.h.
Return the object before obj. Returns 0 if obj is first object.
Implements TSeqCollection.
Definition at line 284 of file TObjArray.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 765 of file TObjArray.cxx.
Definition at line 160 of file TObjArray.h.
Remove all objects from the array.
Does not delete the objects unless the TObjArray is the owner (set via SetOwner()).
Implements TCollection.
Reimplemented in TClonesArray.
Definition at line 298 of file TObjArray.cxx.
|
virtual |
Remove empty slots from array.
Reimplemented in TClonesArray.
Definition at line 309 of file TObjArray.cxx.
Remove all objects from the array AND delete all heap based objects.
Implements TCollection.
Reimplemented in TClonesArray.
Definition at line 329 of file TObjArray.cxx.
Expand or shrink the array to newSize elements.
Reimplemented in TClonesArray.
Definition at line 370 of file TObjArray.cxx.
|
virtual |
Find an object in this collection using its name.
Requires a sequential scan till the object has been found. Returns 0 if object with specified name is not found.
Reimplemented from TCollection.
Definition at line 396 of file TObjArray.cxx.
Find an object in this collection using the object's IsEqual() member function.
Requires a sequential scan till the object has been found. Returns 0 if object is not found. Typically this function is overridden by a more efficient version in concrete collection classes (e.g. THashTable).
Reimplemented from TCollection.
Definition at line 413 of file TObjArray.cxx.
|
virtual |
Return the object in the first slot.
Implements TSeqCollection.
Definition at line 471 of file TObjArray.cxx.
|
protected |
Return absolute index to last object in array.
Returns -1 in case array is empty.
Definition at line 508 of file TObjArray.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 GetEntriesFast() (only in case when there are no empty slots).
Reimplemented from TCollection.
Definition at line 494 of file TObjArray.cxx.
|
inline |
Definition at line 66 of file TObjArray.h.
|
virtual |
Return index of last object in array.
Returns lowerBound-1 in case array is empty.
Reimplemented from TSeqCollection.
Definition at line 528 of file TObjArray.cxx.
|
inline |
Definition at line 70 of file TObjArray.h.
Return address of pointer obj. If obj is 0 returns address of container.
Implements TCollection.
Definition at line 536 of file TObjArray.cxx.
Reimplemented from TSeqCollection.
Definition at line 552 of file TObjArray.cxx.
Initialize a TObjArray.
Definition at line 571 of file TObjArray.cxx.
|
inlinevirtual |
Reimplemented from TCollection.
Definition at line 72 of file TObjArray.h.
|
virtual |
Return the object in the last filled slot. Returns 0 if no entries.
Implements TSeqCollection.
Definition at line 479 of file TObjArray.cxx.
|
inline |
Definition at line 98 of file TObjArray.h.
|
virtual |
Assignment operator. Note, unsets the kIsOwner flag.
Definition at line 106 of file TObjArray.cxx.
Return the object at position i.
Returns address at position 0 if i is out of bounds. Result may be used as an lvalue.
Reimplemented in TClonesArray.
Definition at line 128 of file TObjArray.cxx.
Return the object at position at. Returns 0 if i is out of bounds.
Reimplemented in TClonesArray.
Definition at line 144 of file TObjArray.cxx.
Generate an out-of-bounds error. Always returns false.
Definition at line 599 of file TObjArray.cxx.
Randomize objects inside the array, i.e.
permute randomly objects. With fLast being the index of the last entry in the array, the following algorithm is applied to the array:
Definition at line 723 of file TObjArray.cxx.
Remove object from this collection and recursively remove the object from all other objects (and collections).
Reimplemented from TCollection.
Definition at line 609 of file TObjArray.cxx.
Remove object from array.
Implements TCollection.
Reimplemented in TClonesArray.
Definition at line 653 of file TObjArray.cxx.
Remove object at index idx.
Reimplemented from TSeqCollection.
Reimplemented in TClonesArray.
Definition at line 630 of file TObjArray.cxx.
Remove objects from index idx1 to idx2 included.
Reimplemented in TClonesArray.
Definition at line 675 of file TObjArray.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. If last is -1, this effectively truncate the array completely.
Definition at line 705 of file TObjArray.cxx.
If objects in array are sortable (i.e.
IsSortable() returns true for all objects) then sort array.
Reimplemented in TClonesArray.
Definition at line 744 of file TObjArray.cxx.
Definition at line 91 of file TObjArray.h.
|
friend |
Definition at line 42 of file TObjArray.h.
|
friend |
Definition at line 41 of file TObjArray.h.
|
protected |
Definition at line 45 of file TObjArray.h.
|
protected |
Definition at line 47 of file TObjArray.h.
|
protected |
Array contents.
Definition at line 46 of file TObjArray.h.