Logo ROOT   6.15/01
Reference Guide
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes | List of all members
TCollection Class Referenceabstract

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 63 of file TCollection.h.

Public Types

enum  { kInitCapacity = 16, kInitHashTableCapacity = 17 }
 
- 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)
}
 

Public Member Functions

virtual ~TCollection ()
 TNamed destructor. More...
 
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 TObjectClone (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 TObjectFindObject (const char *name) const
 Find an object in this collection using its name. More...
 
virtual TObjectFindObject (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
 Return the capacity of the collection, i.e. More...
 
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
 
R__ALWAYS_INLINE Bool_t IsUsingRWLock () const
 
virtual void ls (Option_t *option="") const
 List (ls) all objects in this collection. More...
 
virtual TIteratorMakeIterator (Bool_t dir=kIterForward) const =0
 
virtual TIteratorMakeReverseIterator () const
 
virtual Bool_t Notify ()
 'Notify' all objects in this collection. More...
 
TObjectoperator() (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 &regexp, 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 TObjectRemove (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 bool UseRWLock ()
 Set this collection to use a RW lock upon access, making it thread safe. 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...
 
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 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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). 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_tGetDrawOption () 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_tGetOption () 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...
 
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...
 
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...
 
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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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...
 
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...
 

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 TCollectionGetCurrentCollection ()
 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  EStatusBits { kIsOwner = BIT(14), kUseRWLock = BIT(16) }
 

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 TCollectionfgCurrentCollection = 0
 
static Bool_t fgEmptyingGarbage = kFALSE
 
static TObjectTablefgGarbageCollection = 0
 
static Int_t fgGarbageStack = 0
 

#include <TCollection.h>

Inheritance diagram for TCollection:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kInitCapacity 
kInitHashTableCapacity 

Definition at line 157 of file TCollection.h.

◆ EStatusBits

enum TCollection::EStatusBits
protected
Enumerator
kIsOwner 
kUseRWLock 

Definition at line 141 of file TCollection.h.

Constructor & Destructor Documentation

◆ TCollection() [1/2]

TCollection::TCollection ( const TCollection )
private

◆ TCollection() [2/2]

TCollection::TCollection ( )
inlineprotected

Definition at line 150 of file TCollection.h.

◆ ~TCollection()

TCollection::~TCollection ( )
virtual

TNamed destructor.

Definition at line 184 of file TCollection.cxx.

Member Function Documentation

◆ Add()

virtual void TCollection::Add ( TObject obj)
pure virtual

◆ AddAll()

void TCollection::AddAll ( const TCollection col)
virtual

Add all objects from collection col to this collection.

Reimplemented in THashTable.

Definition at line 193 of file TCollection.cxx.

◆ AddVector()

void TCollection::AddVector ( TObject obj1,
  ... 
)

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 206 of file TCollection.cxx.

◆ AssertClass()

Bool_t TCollection::AssertClass ( TClass cl) const

Make sure all objects in this collection inherit from class cl.

Definition at line 221 of file TCollection.cxx.

◆ begin()

TIter TCollection::begin ( ) const
inline

Definition at line 283 of file TCollection.h.

◆ Browse()

void TCollection::Browse ( TBrowser b)
virtual

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 246 of file TCollection.cxx.

◆ Capacity()

Int_t TCollection::Capacity ( ) const
inline

Definition at line 165 of file TCollection.h.

◆ Clear()

virtual void TCollection::Clear ( Option_t option = "")
pure virtual

◆ Clone()

TObject * TCollection::Clone ( const char *  newname = "") const
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 261 of file TCollection.cxx.

◆ Compare()

Int_t TCollection::Compare ( const TObject obj) const
virtual

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 273 of file TCollection.cxx.

◆ Contains() [1/2]

Bool_t TCollection::Contains ( const char *  name) const
inline

Definition at line 169 of file TCollection.h.

◆ Contains() [2/2]

Bool_t TCollection::Contains ( const TObject obj) const
inline

Definition at line 170 of file TCollection.h.

◆ Delete()

virtual void TCollection::Delete ( Option_t option = "")
pure virtual

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, TList, TListOfEnums, TBtree, TMap, TRefArray, THashTable, TListOfDataMembers, TObjArray, TOrdCollection, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TClonesArray, THashList, and TListOfEnumsWithLock.

◆ Draw()

void TCollection::Draw ( Option_t option = "")
virtual

Draw all objects in this collection.

Reimplemented from TObject.

Definition at line 282 of file TCollection.cxx.

◆ Dump()

void TCollection::Dump ( ) const
virtual

Dump all objects in this collection.

Reimplemented from TObject.

Definition at line 295 of file TCollection.cxx.

◆ EmptyGarbageCollection()

void TCollection::EmptyGarbageCollection ( )
static

Do the garbage collection.

Definition at line 708 of file TCollection.cxx.

◆ end()

TIter TCollection::end ( ) const
inline

Definition at line 284 of file TCollection.h.

◆ FindObject() [1/2]

TObject * TCollection::FindObject ( const char *  name) const
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 TList, TObjArray, TBtree, TMap, TListOfDataMembers, THashTable, TListOfFunctions, TListOfFunctionTemplates, THashList, TListOfEnumsWithLock, TViewPubDataMembers, TViewPubFunctions, and TListOfTypes.

Definition at line 310 of file TCollection.cxx.

◆ FindObject() [2/2]

TObject * TCollection::FindObject ( const TObject obj) const
virtual

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 TList, TObjArray, TBtree, TMap, THashTable, TListOfFunctions, THashList, TListOfEnumsWithLock, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 335 of file TCollection.cxx.

◆ GarbageCollect()

void TCollection::GarbageCollect ( TObject obj)
static

Add to the list of things to be cleaned up.

Definition at line 723 of file TCollection.cxx.

◆ GetCollectionEntryName()

const char * TCollection::GetCollectionEntryName ( TObject entry) const
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 435 of file TCollection.cxx.

◆ GetCurrentCollection()

TCollection * TCollection::GetCurrentCollection ( )
static

Return the globally accessible collection.

Definition at line 678 of file TCollection.cxx.

◆ GetEntries()

virtual Int_t TCollection::GetEntries ( ) const
inlinevirtual

Reimplemented in TRefArray, and TObjArray.

Definition at line 177 of file TCollection.h.

◆ GetName()

const char * TCollection::GetName ( ) const
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 349 of file TCollection.cxx.

◆ GetObjectRef()

virtual TObject** TCollection::GetObjectRef ( const TObject obj) const
pure virtual

◆ GetSize()

virtual Int_t TCollection::GetSize ( ) const
inlinevirtual

Return the capacity of the collection, i.e.

the current total amount of space that has been allocated so far. Same as Capacity. Use GetEntries to get the number of elements currently in the collection.

Reimplemented in TListOfFunctions, THashTable, TListOfEnumsWithLock, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 182 of file TCollection.h.

◆ GrowBy()

Int_t TCollection::GrowBy ( Int_t  delta) const
virtual

Increase the collection's capacity by delta slots.

Definition at line 358 of file TCollection.cxx.

◆ Hash()

ULong_t TCollection::Hash ( ) const
inlinevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Definition at line 184 of file TCollection.h.

◆ IsArgNull()

Bool_t TCollection::IsArgNull ( const char *  where,
const TObject obj 
) const

Returns true if object is a null pointer.

Definition at line 370 of file TCollection.cxx.

◆ IsEmpty()

virtual Bool_t TCollection::IsEmpty ( ) const
inlinevirtual

Reimplemented in TRefArray, and TObjArray.

Definition at line 186 of file TCollection.h.

◆ IsFolder()

virtual Bool_t TCollection::IsFolder ( ) const
inlinevirtual

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented from TObject.

Definition at line 187 of file TCollection.h.

◆ IsOwner()

Bool_t TCollection::IsOwner ( ) const
inline

Definition at line 188 of file TCollection.h.

◆ IsSortable()

Bool_t TCollection::IsSortable ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 189 of file TCollection.h.

◆ IsUsingRWLock()

R__ALWAYS_INLINE Bool_t TCollection::IsUsingRWLock ( ) const
inline

Definition at line 210 of file TCollection.h.

◆ ls()

void TCollection::ls ( Option_t option = "") const
virtual

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 380 of file TCollection.cxx.

◆ MakeIterator()

virtual TIterator* TCollection::MakeIterator ( Bool_t  dir = kIterForward) const
pure virtual

◆ MakeReverseIterator()

virtual TIterator* TCollection::MakeReverseIterator ( ) const
inlinevirtual

Definition at line 193 of file TCollection.h.

◆ Notify()

Bool_t TCollection::Notify ( )
virtual

'Notify' all objects in this collection.

Reimplemented from TObject.

Definition at line 405 of file TCollection.cxx.

◆ operator()()

TObject * TCollection::operator() ( const char *  name) const

Find an object in this collection by name.

Definition at line 323 of file TCollection.cxx.

◆ operator=()

void TCollection::operator= ( const TCollection )
private

◆ Paint()

void TCollection::Paint ( Option_t option = "")
virtual

Paint all objects in this collection.

Reimplemented from TObject.

Definition at line 415 of file TCollection.cxx.

◆ Print() [1/4]

void TCollection::Print ( Option_t option = "") const
virtual

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:

void PrintCollectionHeader(Option_t* option) const;
const char* GetCollectionEntryName(TObject* entry) const;
void PrintCollectionEntry(TObject* entry, Option_t* option, Int_t recurse) const;

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 474 of file TCollection.cxx.

◆ Print() [2/4]

void TCollection::Print ( Option_t option,
Int_t  recurse 
) const
virtual

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 THashTable, and TProofOutputList.

Definition at line 488 of file TCollection.cxx.

◆ Print() [3/4]

void TCollection::Print ( Option_t option,
const char *  wildcard,
Int_t  recurse = 1 
) const
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 515 of file TCollection.cxx.

◆ Print() [4/4]

void TCollection::Print ( Option_t option,
TPRegexp regexp,
Int_t  recurse = 1 
) const
virtual

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 548 of file TCollection.cxx.

◆ PrintCollectionEntry()

void TCollection::PrintCollectionEntry ( TObject entry,
Option_t option,
Int_t  recurse 
) const
protectedvirtual

Print the collection entry.

Reimplemented in TQUndoManager, TMap, and TAlienJobStatusList.

Definition at line 443 of file TCollection.cxx.

◆ PrintCollectionHeader()

void TCollection::PrintCollectionHeader ( Option_t option) const
protectedvirtual

Print the collection header.

Reimplemented in TQCommand, and TQConnection.

Definition at line 423 of file TCollection.cxx.

◆ RecursiveRemove()

void TCollection::RecursiveRemove ( TObject obj)
virtual

Remove object from this collection and recursively remove the object from all other objects (and collections).

Reimplemented from TObject.

Reimplemented in TList, TListOfFunctions, TListOfDataMembers, TListOfEnums, TObjArray, TListOfFunctionTemplates, TListOfEnumsWithLock, TViewPubDataMembers, TViewPubFunctions, and THashList.

Definition at line 572 of file TCollection.cxx.

◆ Remove()

virtual TObject* TCollection::Remove ( TObject obj)
pure virtual

◆ RemoveAll() [1/2]

void TCollection::RemoveAll ( TCollection col)
virtual

Remove all objects in collection col from this collection.

Definition at line 592 of file TCollection.cxx.

◆ RemoveAll() [2/2]

void TCollection::RemoveAll ( )
inline

Definition at line 202 of file TCollection.h.

◆ SetCurrentCollection()

void TCollection::SetCurrentCollection ( )

Set this collection to be the globally accesible collection.

Definition at line 686 of file TCollection.cxx.

◆ SetName()

void TCollection::SetName ( const char *  name)
inline

Definition at line 204 of file TCollection.h.

◆ SetOwner()

void TCollection::SetOwner ( Bool_t  enable = kTRUE)
virtual

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 744 of file TCollection.cxx.

◆ StartGarbageCollection()

void TCollection::StartGarbageCollection ( )
static

Set up for garbage collection.

Definition at line 694 of file TCollection.cxx.

◆ UseRWLock()

bool TCollection::UseRWLock ( )
virtual

Set this collection to use a RW lock upon access, making it thread safe.

Return the previous state.

Note: To test whether the usage is enabled do: collection->TestBit(TCollection::kUseRWLock);

Reimplemented in THashList.

Definition at line 759 of file TCollection.cxx.

◆ Write() [1/2]

Int_t TCollection::Write ( const char *  name = 0,
Int_t  option = 0,
Int_t  bsize = 0 
)
virtual

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 670 of file TCollection.cxx.

◆ Write() [2/2]

Int_t TCollection::Write ( const char *  name = 0,
Int_t  option = 0,
Int_t  bsize = 0 
) const
virtual

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 646 of file TCollection.cxx.

Member Data Documentation

◆ fgCurrentCollection

TCollection * TCollection::fgCurrentCollection = 0
staticprivate

Definition at line 132 of file TCollection.h.

◆ fgEmptyingGarbage

Bool_t TCollection::fgEmptyingGarbage = kFALSE
staticprivate

Definition at line 134 of file TCollection.h.

◆ fgGarbageCollection

TObjectTable * TCollection::fgGarbageCollection = 0
staticprivate

Definition at line 133 of file TCollection.h.

◆ fgGarbageStack

Int_t TCollection::fgGarbageStack = 0
staticprivate

Definition at line 135 of file TCollection.h.

◆ fName

TString TCollection::fName
protected

Definition at line 147 of file TCollection.h.

◆ fSize

Int_t TCollection::fSize
protected

Definition at line 148 of file TCollection.h.

Libraries for TCollection:
[legend]

The documentation for this class was generated from the following files: