Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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 65 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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

virtual ~TCollection ()
 TNamed destructor.
 
virtual void Add (TObject *obj)=0
 
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) override
 Browse this collection (called by TBrowser).
 
Int_t Capacity () const
 
void Clear (Option_t *option="") override=0
 
TObjectClone (const char *newname="") const override
 Make a clone of an collection using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TCollection objects.
 
Bool_t Contains (const char *name) const
 
Bool_t Contains (const TObject *obj) const
 
void Delete (Option_t *option="") override=0
 Delete this object.
 
void Draw (Option_t *option="") override
 Draw all objects in this collection.
 
void Dump () const override
 Dump all objects in this collection.
 
TIter end () const
 
TObjectFindObject (const char *name) const override
 Find an object in this collection using its name.
 
TObjectFindObject (const TObject *obj) const override
 Find an object in this collection using the object's IsEqual() member function.
 
virtual Int_t GetEntries () const
 
const char * GetName () const override
 Return name of this collection.
 
virtual TObject ** GetObjectRef (const TObject *obj) const =0
 
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 override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsArgNull (const char *where, const TObject *obj) const
 Returns true if object is a null pointer.
 
virtual Bool_t IsEmpty () const
 
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
Bool_t IsOwner () const
 
Bool_t IsSortable () const override
 
R__ALWAYS_INLINE Bool_t IsUsingRWLock () const
 
void ls (Option_t *option="") const override
 List (ls) all objects in this collection.
 
virtual TIteratorMakeIterator (Bool_t dir=kIterForward) const =0
 
virtual TIteratorMakeReverseIterator () const
 
Bool_t Notify () override
 'Notify' all objects in this collection.
 
TObjectoperator() (const char *name) const
 Find an object in this collection by name.
 
void Paint (Option_t *option="") override
 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 &regexp, Int_t recurse=1) const
 Print the collection header and its elements that match the regexp.
 
void Print (Option_t *option="") const override
 Default print for collections, calls Print(option, 1).
 
void RecursiveRemove (TObject *obj) override
 Remove object from this collection and recursively remove the object from all other objects (and collections).
 
virtual TObjectRemove (TObject *obj)=0
 
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.
 
void Streamer (TBuffer &) override
 Stream all objects in the collection to or from the I/O buffer.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual bool UseRWLock (Bool_t enable=true)
 Set this collection to use a RW lock upon access, making it thread safe.
 
Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const override
 Write all objects in this collection.
 
Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) override
 Write all objects in this collection.
 
- Public Member Functions inherited from TObject
 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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
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=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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_tGetDrawOption () 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_tGetOption () 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)
 
TObjectoperator= (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.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static void EmptyGarbageCollection ()
 Do the garbage collection.
 
static void GarbageCollect (TObject *obj)
 Add to the list of things to be cleaned up.
 
static TCollectionGetCurrentCollection ()
 Return the globally accessible collection.
 
static void StartGarbageCollection ()
 Set up for garbage collection.
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
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.
 

Protected Types

enum  EStatusBits { kIsOwner = (1ULL << ( 14 )) , kUseRWLock = (1ULL << ( 16 )) }
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

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.
 
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.
 
- 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).
 
void MakeZombie ()
 

Protected Attributes

TString fName
 
Int_t fSize
 

Private Member Functions

 TCollection (const TCollection &)=delete
 
void operator= (const TCollection &)=delete
 

Static Private Attributes

static TCollectionfgCurrentCollection = nullptr
 
static Bool_t fgEmptyingGarbage = kFALSE
 
static TObjectTablefgGarbageCollection = nullptr
 
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 159 of file TCollection.h.

◆ EStatusBits

enum TCollection::EStatusBits
protected
Enumerator
kIsOwner 
kUseRWLock 

Definition at line 143 of file TCollection.h.

Constructor & Destructor Documentation

◆ TCollection() [1/2]

TCollection::TCollection ( const TCollection )
privatedelete

◆ TCollection() [2/2]

TCollection::TCollection ( )
inlineprotected

Definition at line 152 of file TCollection.h.

◆ ~TCollection()

TCollection::~TCollection ( )
virtual

TNamed destructor.

Definition at line 186 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 195 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 208 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 223 of file TCollection.cxx.

◆ begin()

TIter TCollection::begin ( ) const
inline

Definition at line 292 of file TCollection.h.

◆ Browse()

void TCollection::Browse ( TBrowser b)
overridevirtual

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.

Reimplemented in TRootIconList.

Definition at line 248 of file TCollection.cxx.

◆ Capacity()

Int_t TCollection::Capacity ( ) const
inline

Definition at line 167 of file TCollection.h.

◆ Class()

static TClass * TCollection::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TCollection::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TCollection::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 222 of file TCollection.h.

◆ Clear()

◆ Clone()

TObject * TCollection::Clone ( const char *  newname = "") const
overridevirtual

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

◆ Compare()

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

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

◆ Contains() [1/2]

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

Definition at line 171 of file TCollection.h.

◆ Contains() [2/2]

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

Definition at line 172 of file TCollection.h.

◆ DeclFileName()

static const char * TCollection::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 222 of file TCollection.h.

◆ Delete()

void TCollection::Delete ( Option_t option = "")
overridepure 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, TBtree, TClonesArray, THashList, THashTable, TList, TMap, TObjArray, TOrdCollection, TRefArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, and TViewPubFunctions.

◆ Draw()

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

Draw all objects in this collection.

Reimplemented from TObject.

Definition at line 284 of file TCollection.cxx.

◆ Dump()

void TCollection::Dump ( ) const
overridevirtual

Dump all objects in this collection.

Reimplemented from TObject.

Definition at line 297 of file TCollection.cxx.

◆ EmptyGarbageCollection()

void TCollection::EmptyGarbageCollection ( )
static

Do the garbage collection.

Definition at line 710 of file TCollection.cxx.

◆ end()

TIter TCollection::end ( ) const
inline

Definition at line 293 of file TCollection.h.

◆ FindObject() [1/2]

TObject * TCollection::FindObject ( const char *  name) const
overridevirtual

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

Definition at line 312 of file TCollection.cxx.

◆ FindObject() [2/2]

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

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

Definition at line 337 of file TCollection.cxx.

◆ GarbageCollect()

void TCollection::GarbageCollect ( TObject obj)
static

Add to the list of things to be cleaned up.

Definition at line 725 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 437 of file TCollection.cxx.

◆ GetCurrentCollection()

TCollection * TCollection::GetCurrentCollection ( )
static

Return the globally accessible collection.

Definition at line 680 of file TCollection.cxx.

◆ GetEntries()

virtual Int_t TCollection::GetEntries ( ) const
inlinevirtual

Reimplemented in TObjArray, and TRefArray.

Definition at line 179 of file TCollection.h.

◆ GetName()

const char * TCollection::GetName ( ) const
overridevirtual

Return name of this collection.

if no name, return the collection class name.

Reimplemented from TObject.

Reimplemented in TQCommand, and TQConnection.

Definition at line 351 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 THashTable, TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 184 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 360 of file TCollection.cxx.

◆ Hash()

ULong_t TCollection::Hash ( ) const
inlineoverridevirtual

Return hash value for this object.

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

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:395

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.
ULong_t Hash() const override
Return hash value for this object.
Mother of all ROOT objects.
Definition TObject.h:41
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:976
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2459

Reimplemented from TObject.

Definition at line 186 of file TCollection.h.

◆ IsA()

◆ IsArgNull()

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

Returns true if object is a null pointer.

Definition at line 372 of file TCollection.cxx.

◆ IsEmpty()

virtual Bool_t TCollection::IsEmpty ( ) const
inlinevirtual

Reimplemented in TObjArray, and TRefArray.

Definition at line 188 of file TCollection.h.

◆ IsFolder()

Bool_t TCollection::IsFolder ( ) const
inlineoverridevirtual

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

Reimplemented from TObject.

Reimplemented in TRootIconList.

Definition at line 189 of file TCollection.h.

◆ IsOwner()

Bool_t TCollection::IsOwner ( ) const
inline

Definition at line 190 of file TCollection.h.

◆ IsSortable()

Bool_t TCollection::IsSortable ( ) const
inlineoverridevirtual

Reimplemented from TObject.

Definition at line 191 of file TCollection.h.

◆ IsUsingRWLock()

R__ALWAYS_INLINE Bool_t TCollection::IsUsingRWLock ( ) const
inline

Definition at line 212 of file TCollection.h.

◆ ls()

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

List (ls) all objects in this collection.

Wildcarding supported, eg option="xxx*" lists only objects with names xxx*.

Reimplemented from TObject.

Reimplemented in TQCommand, TQUndoManager, TQConnection, TQConnectionList, and TProofOutputList.

Definition at line 382 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 195 of file TCollection.h.

◆ Notify()

Bool_t TCollection::Notify ( )
overridevirtual

'Notify' all objects in this collection.

Reimplemented from TObject.

Reimplemented in TGTextEditHist.

Definition at line 407 of file TCollection.cxx.

◆ operator()()

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

Find an object in this collection by name.

Definition at line 325 of file TCollection.cxx.

◆ operator=()

void TCollection::operator= ( const TCollection )
privatedelete

◆ Paint()

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

Paint all objects in this collection.

Reimplemented from TObject.

Definition at line 417 of file TCollection.cxx.

◆ Print() [1/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 THashTable, and TProofOutputList.

Definition at line 517 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, THashTable, and TProofOutputList.

Definition at line 490 of file TCollection.cxx.

◆ Print() [3/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 THashTable, and TProofOutputList.

Definition at line 550 of file TCollection.cxx.

◆ Print() [4/4]

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

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:

const char* GetCollectionEntryName(TObject* entry) const;
void PrintCollectionEntry(TObject* entry, Option_t* option, Int_t recurse) const;
const char Option_t
Definition RtypesCore.h:66
Option_t Option_t option
virtual void PrintCollectionEntry(TObject *entry, Option_t *option, Int_t recurse) const
Print the collection entry.
virtual const char * GetCollectionEntryName(TObject *entry) const
For given collection entry return the string that is used to identify the object and,...
virtual void PrintCollectionHeader(Option_t *option) const
Print the collection header.

Otherwise override the Print(Option_t *option, Int_t) variant. Remember to declare:

void Print(Option_t *option="") const override
Default print for collections, calls Print(option, 1).

somewhere close to the method declaration.

Reimplemented from TObject.

Reimplemented in THashTable, and TProofOutputList.

Definition at line 476 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, and TMap.

Definition at line 445 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 425 of file TCollection.cxx.

◆ RecursiveRemove()

void TCollection::RecursiveRemove ( TObject obj)
overridevirtual

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

Reimplemented from TObject.

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

Definition at line 574 of file TCollection.cxx.

◆ Remove()

◆ RemoveAll() [1/2]

void TCollection::RemoveAll ( )
inline

Definition at line 204 of file TCollection.h.

◆ RemoveAll() [2/2]

void TCollection::RemoveAll ( TCollection col)
virtual

Remove all objects in collection col from this collection.

Definition at line 594 of file TCollection.cxx.

◆ SetCurrentCollection()

void TCollection::SetCurrentCollection ( )

Set this collection to be the globally accessible collection.

Definition at line 688 of file TCollection.cxx.

◆ SetName()

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

Definition at line 206 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 deleted. The objects might also be deleted or destructed when Clear is called (depending on the collection).

Reimplemented in TClonesArray.

Definition at line 746 of file TCollection.cxx.

◆ StartGarbageCollection()

void TCollection::StartGarbageCollection ( )
static

Set up for garbage collection.

Definition at line 696 of file TCollection.cxx.

◆ Streamer()

void TCollection::Streamer ( TBuffer b)
overridevirtual

◆ StreamerNVirtual()

void TCollection::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 222 of file TCollection.h.

◆ UseRWLock()

bool TCollection::UseRWLock ( Bool_t  enable = true)
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 761 of file TCollection.cxx.

◆ Write() [1/2]

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

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

◆ Write() [2/2]

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

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

Member Data Documentation

◆ fgCurrentCollection

TCollection * TCollection::fgCurrentCollection = nullptr
staticprivate

Definition at line 134 of file TCollection.h.

◆ fgEmptyingGarbage

Bool_t TCollection::fgEmptyingGarbage = kFALSE
staticprivate

Definition at line 136 of file TCollection.h.

◆ fgGarbageCollection

TObjectTable * TCollection::fgGarbageCollection = nullptr
staticprivate

Definition at line 135 of file TCollection.h.

◆ fgGarbageStack

Int_t TCollection::fgGarbageStack = 0
staticprivate

Definition at line 137 of file TCollection.h.

◆ fName

TString TCollection::fName
protected

Definition at line 149 of file TCollection.h.

◆ fSize

Int_t TCollection::fSize
protected

Definition at line 150 of file TCollection.h.

  • core/cont/inc/TCollection.h
  • core/cont/src/TCollection.cxx