ROOT 6.08/07 Reference Guide |
Collection abstract base class.
This class describes the base protocol all collection classes have to implement. The ROOT collection classes always store pointers to objects that inherit from TObject. They never adopt the objects. Therefore, it is the user's responsibility to take care of deleting the actual objects once they are not needed anymore. In exceptional cases, when the user is 100% sure nothing else is referencing the objects in the collection, one can delete all objects and the collection at the same time using the Delete() function.
Collections can be iterated using an iterator object (see TIterator). Depending on the concrete collection class there may be some additional methods of iterating. See the respective classes.
TCollection inherits from TObject since we want to be able to have collections of collections.
In a later release the collections may become templatized.
Definition at line 48 of file TCollection.h.
Public Types | |
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 | |
virtual | ~TCollection () |
virtual void | Add (TObject *obj)=0 |
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 void | Clear (Option_t *option="")=0 |
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 | Delete (Option_t *option="")=0 |
Delete this object. More... | |
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 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... | |
virtual Int_t | GetEntries () const |
virtual const char * | GetName () const |
Return name of this collection. More... | |
virtual TObject ** | GetObjectRef (const TObject *obj) const =0 |
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 | IsEmpty () const |
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 * | MakeIterator (Bool_t dir=kIterForward) const =0 |
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 | 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)=0 |
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... | |
Static Public Member Functions | |
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 | |
enum | { kIsOwner = BIT(14) } |
Protected Member Functions | |
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 | |
TString | fName |
Int_t | fSize |
Private Member Functions | |
TCollection (const TCollection &) | |
void | operator= (const TCollection &) |
Static Private Attributes | |
static TCollection * | fgCurrentCollection = 0 |
static Bool_t | fgEmptyingGarbage = kFALSE |
static TObjectTable * | fgGarbageCollection = 0 |
static Int_t | fgGarbageStack = 0 |
#include <TCollection.h>
|
protected |
Enumerator | |
---|---|
kIsOwner |
Definition at line 60 of file TCollection.h.
anonymous enum |
Enumerator | |
---|---|
kInitCapacity | |
kInitHashTableCapacity |
Definition at line 72 of file TCollection.h.
|
private |
|
inlineprotected |
Definition at line 65 of file TCollection.h.
|
inlinevirtual |
Definition at line 74 of file TCollection.h.
Implemented in TQUndoManager, TQCommand, TBtree, TRefArray, TList, TObjArray, TMap, THashTable, TSeqCollection, and TSortedList.
|
virtual |
Add all objects from collection col to this collection.
Reimplemented in THashTable.
Definition at line 58 of file TCollection.cxx.
Add all arguments to the collection.
The list of objects must be terminated by 0, e.g.: l.AddVector(o1, o2, o3, o4, 0);
Definition at line 71 of file TCollection.cxx.
Make sure all objects in this collection inherit from class cl.
Definition at line 86 of file TCollection.cxx.
|
inline |
Definition at line 192 of file TCollection.h.
Browse this collection (called by TBrowser).
If b=0, there is no Browse call TObject::Browse(0) instead. This means TObject::Inspect() will be invoked indirectly
Reimplemented from TObject.
Definition at line 111 of file TCollection.cxx.
|
inline |
Definition at line 80 of file TCollection.h.
Reimplemented from TObject.
Implemented in TListOfEnums, TBtree, TList, TRefArray, TMap, TListOfDataMembers, THashTable, TListOfFunctions, TListOfFunctionTemplates, TOrdCollection, TObjArray, TViewPubDataMembers, TViewPubFunctions, TClonesArray, THashList, and TListOfEnumsWithLock.
|
virtual |
Make a clone of an collection using the Streamer facility.
If newname is specified, this will be the name of the new collection.
Reimplemented from TObject.
Definition at line 126 of file TCollection.cxx.
Compare two TCollection objects.
Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp()).
Reimplemented from TObject.
Definition at line 138 of file TCollection.cxx.
|
inline |
Definition at line 84 of file TCollection.h.
Definition at line 85 of file TCollection.h.
Delete this object.
Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.
Reimplemented from TObject.
Implemented in TQCommand, TListOfEnums, TBtree, TList, TMap, TRefArray, TListOfDataMembers, THashTable, TListOfFunctions, TListOfFunctionTemplates, TObjArray, TOrdCollection, TViewPubDataMembers, TViewPubFunctions, TClonesArray, THashList, and TListOfEnumsWithLock.
Draw all objects in this collection.
Reimplemented from TObject.
Definition at line 147 of file TCollection.cxx.
|
virtual |
Dump all objects in this collection.
Reimplemented from TObject.
Definition at line 160 of file TCollection.cxx.
|
static |
Do the garbage collection.
Definition at line 564 of file TCollection.cxx.
|
inline |
Definition at line 193 of file TCollection.h.
|
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 TObject.
Reimplemented in TObjArray, TBtree, TList, TMap, TListOfDataMembers, THashTable, TListOfFunctions, TListOfFunctionTemplates, THashList, TListOfEnumsWithLock, TViewPubDataMembers, TViewPubFunctions, and TListOfTypes.
Definition at line 175 of file TCollection.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 TObject.
Reimplemented in TObjArray, TBtree, TList, TMap, THashTable, TListOfFunctions, THashList, TListOfEnumsWithLock, TViewPubDataMembers, and TViewPubFunctions.
Definition at line 200 of file TCollection.cxx.
Add to the list of things to be cleaned up.
Definition at line 579 of file TCollection.cxx.
|
protectedvirtual |
For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on.
Definition at line 291 of file TCollection.cxx.
|
static |
Return the globally accessible collection.
Definition at line 534 of file TCollection.cxx.
|
inlinevirtual |
Reimplemented in TRefArray, and TObjArray.
Definition at line 92 of file TCollection.h.
|
virtual |
Return name of this collection.
if no name, return the collection class name.
Reimplemented from TObject.
Reimplemented in TQCommand, and TQConnection.
Definition at line 214 of file TCollection.cxx.
Implemented in TList, TBtree, TMap, TRefArray, TListOfFunctions, TViewPubDataMembers, TViewPubFunctions, THashTable, TObjArray, TOrdCollection, and TListOfEnumsWithLock.
|
inlinevirtual |
Reimplemented in TListOfFunctions, THashTable, TListOfEnumsWithLock, TViewPubDataMembers, and TViewPubFunctions.
Definition at line 95 of file TCollection.h.
Increase the collection's capacity by delta slots.
Definition at line 223 of file TCollection.cxx.
|
inlinevirtual |
Return hash value for this object.
Reimplemented from TObject.
Definition at line 97 of file TCollection.h.
Returns true if object is a null pointer.
Definition at line 235 of file TCollection.cxx.
|
inlinevirtual |
Reimplemented in TRefArray, and TObjArray.
Definition at line 99 of file TCollection.h.
|
inlinevirtual |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Reimplemented from TObject.
Definition at line 100 of file TCollection.h.
|
inline |
Definition at line 101 of file TCollection.h.
|
inlinevirtual |
Reimplemented from TObject.
Definition at line 102 of file TCollection.h.
List (ls) all objects in this collection.
Wildcarding supported, eg option="xxx*" lists only objects with names xxx*.
Reimplemented from TObject.
Reimplemented in TQUndoManager, TQConnection, TQCommand, and TProofOutputList.
Definition at line 245 of file TCollection.cxx.
|
pure virtual |
Implemented in TMap, TBtree, TRefArray, TList, THashTable, TObjArray, TListOfFunctions, TOrdCollection, TListOfEnumsWithLock, TViewPubDataMembers, and TViewPubFunctions.
|
inlinevirtual |
Definition at line 105 of file TCollection.h.
TObject * TCollection::operator() | ( | const char * | name | ) | const |
Find an object in this collection by name.
Definition at line 188 of file TCollection.cxx.
|
private |
Paint all objects in this collection.
Reimplemented from TObject.
Definition at line 271 of file TCollection.cxx.
Default print for collections, calls Print(option, 1).
This will print the collection header and Print() methods of all the collection entries.
If you want to override Print() for a collection class, first see if you can accomplish it by overriding the following protected methods:
Otherwise override the Print(Option_t *option, Int_t)
variant. Remember to declare:
somewhere close to the method declaration.
Reimplemented from TObject.
Reimplemented in TGLiteResult, TAlienResult, and TProofOutputList.
Definition at line 330 of file TCollection.cxx.
Print the collection header and its elements.
If recurse is non-zero, descend into printing of collection-entries with recurse - 1. This means, if recurse is negative, the recursion is infinite.
Option is passed recursively.
Reimplemented in TProofOutputList.
Definition at line 344 of file TCollection.cxx.
|
virtual |
Print the collection header and its elements that match the wildcard.
If recurse is non-zero, descend into printing of collection-entries with recurse - 1. This means, if recurse is negative, the recursion is infinite.
Option is passed recursively, but wildcard is only used on the first level.
Reimplemented in TProofOutputList.
Definition at line 371 of file TCollection.cxx.
Print the collection header and its elements that match the regexp.
If recurse is non-zero, descend into printing of collection-entries with recurse - 1. This means, if recurse is negative, the recursion is infinite.
Option is passed recursively, but regexp is only used on the first level.
Reimplemented in TProofOutputList.
Definition at line 404 of file TCollection.cxx.
|
protectedvirtual |
Print the collection entry.
Reimplemented in TQUndoManager, TMap, and TAlienJobStatusList.
Definition at line 299 of file TCollection.cxx.
Print the collection header.
Reimplemented in TQConnection, and TQCommand.
Definition at line 279 of file TCollection.cxx.
Remove object from this collection and recursively remove the object from all other objects (and collections).
Reimplemented from TObject.
Reimplemented in TListOfFunctions, TList, TListOfDataMembers, TListOfEnums, TObjArray, TListOfFunctionTemplates, TListOfEnumsWithLock, TViewPubDataMembers, TViewPubFunctions, and THashList.
Definition at line 428 of file TCollection.cxx.
|
virtual |
Remove all objects in collection col from this collection.
Definition at line 448 of file TCollection.cxx.
|
inline |
Definition at line 114 of file TCollection.h.
void TCollection::SetCurrentCollection | ( | ) |
Set this collection to be the globally accesible collection.
Definition at line 542 of file TCollection.cxx.
|
inline |
Definition at line 116 of file TCollection.h.
Set whether this collection is the owner (enable==true) of its content.
If it is the owner of its contents, these objects will be deleted whenever the collection itself is delete. The objects might also be deleted or destructed when Clear is called (depending on the collection).
Reimplemented in TClonesArray.
Definition at line 600 of file TCollection.cxx.
|
static |
Set up for garbage collection.
Definition at line 550 of file TCollection.cxx.
Write all objects in this collection.
By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).
Reimplemented from TObject.
Reimplemented in TMap.
Definition at line 526 of file TCollection.cxx.
Write all objects in this collection.
By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).
Reimplemented from TObject.
Reimplemented in TMap.
Definition at line 502 of file TCollection.cxx.
|
staticprivate |
Definition at line 51 of file TCollection.h.
Definition at line 53 of file TCollection.h.
|
staticprivate |
Definition at line 52 of file TCollection.h.
|
staticprivate |
Definition at line 54 of file TCollection.h.
|
protected |
Definition at line 62 of file TCollection.h.
|
protected |
Definition at line 63 of file TCollection.h.