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.

The following describes how you can access the elements in case an interface returns a ROOT collection type such as TList or TObjArray. These type of ROOT collections hold pointers to TObject. In other words, to store an object in a ROOT collection, it must inherit from TObject. You can think of a TList as a std::list<TObject*>.

Note: For historical reasons, some of ROOT’s interfaces use ROOT’s own collection types such as TList and TObjArray. In modern code (within ROOT and your own), it's recommended to rather use std::array or std::vector etc. from the C++ Standard Library, and their standard iterators.

Traditional ways of iterating through these elements rely on the use of TIter, R__FOR_EACH, std::for_each, range-based for, TObjLink::Next or TList::After, as described in the 6 examples of TList documentation.

However, these ways of retrieval through the parent class TObject* are often not useful, since those pointers have to be cast back to the correct subclass. For instance, with TTree::GetListOfBranches(), you know that the derived class is of type TBranch*. For this purpose, ROOT offers a specific tools for range-based for loops: such as ROOT::RRangeCast, TRangeStaticCast and TRangeDynCast (in this example):

for (auto br : TRangeDynCast<TBranch>( tree->GetListOfBranches() )) {
    if (!br) continue;
    // Use br as a TBranch*
}

Definition at line 65 of file TCollection.h.

Public Types
enum	{ kInitCapacity = 16 , kInitHashTableCapacity = 17 }
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }
enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }

Public Member Functions
virtual	~TCollection ()
	TNamed destructor.
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
virtual void	Add (TObject , Option_t )
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.
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
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
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.
void	Clear (Option_t *option="") override=0
TObject *	Clone (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
virtual void	Copy (TObject &object) const
	Copy this to obj.
void	Delete (Option_t *option="") override=0
	Delete this object.
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.
void	Draw (Option_t *option="") override
	Draw all objects in this collection.
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
void	Dump () const override
	Dump all objects in this collection.
TIter	end () const
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.
TObject *	FindObject (const char *name) const override
	Find an object in this collection using its name.
TObject *	FindObject (const TObject *obj) const override
	Find an object in this collection using the object's IsEqual() member function.
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
virtual Int_t	GetEntries () const
virtual const char *	GetIconName () const
	Returns mime type name of object.
const char *	GetName () const override
	Return name of this collection.
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).
virtual TObject **	GetObjectRef (const TObject *obj) const =0
virtual Option_t *	GetOption () const
virtual Int_t	GetSize () const
	Return the capacity of the collection, i.e.
virtual const char *	GetTitle () const
	Returns title of object.
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
virtual Int_t	GrowBy (Int_t delta) const
	Increase the collection's capacity by delta slots.
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
ULong_t	Hash () const override
	Return hash value for this object.
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)
TClass *	IsA () const override
Bool_t	IsArgNull (const char where, const TObject obj) const
	Returns true if object is a null pointer.
Bool_t	IsDestructed () const
	IsDestructed.
virtual Bool_t	IsEmpty () const
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).
Bool_t	IsFolder () const override
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t	IsOnHeap () const
Bool_t	IsOwner () const
Bool_t	IsSortable () const override
Bool_t	IsUsingRWLock () const
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List (ls) all objects in this collection.
virtual TIterator *	MakeIterator (Bool_t dir=kIterForward) const =0
virtual TIterator *	MakeReverseIterator () 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).
Bool_t	Notify () override
	'Notify' all objects in this collection.
void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *, size_t)
	Operator delete for sized deallocation.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.
void	operator delete[] (void *, size_t)
	Operator delete [] for sized deallocation.
void	operator delete[] (void *ptr)
	Operator delete [].
void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.
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 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	Pop ()
	Pop on object drawn in a pad to the top of the display list.
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).
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
void	RecursiveRemove (TObject *obj) override
	Remove object from this collection and recursively remove the object from all other objects (and collections).
virtual TObject *	Remove (TObject *obj)=0
void	RemoveAll ()
virtual void	RemoveAll (TCollection *col)
	Remove all objects in collection col from this collection.
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.
void	SetCurrentCollection ()
	Set this collection to be the globally accessible collection.
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
void	SetName (const char *name)
virtual void	SetOwner (Bool_t enable=kTRUE)
	Set whether this collection is the owner (enable==true) of its content.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
std::size_t	size () const
void	Streamer (TBuffer &) override
	Stream all objects in the collection to or from the I/O buffer.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.
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 bool	UseRWLock (Bool_t enable=true)
	Set this collection to use a RW lock upon access, making it thread safe.
virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.
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.

Static Public Member Functions
static TClass *	Class ()
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 TCollection *	GetCurrentCollection ()
	Return the globally accessible collection.
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.
static Bool_t	GetObjectStat ()
	Get status of object stat flag.
static void	SetDtorOnly (void *obj)
	Set destructor only flag.
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.
static void	StartGarbageCollection ()
	Set up for garbage collection.

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

Protected Member Functions
	TCollection ()
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).
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.
void	MakeZombie ()
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.

Static Protected Member Functions
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Int_t flag=0)
	Save array in the output stream "out" as vector.

Protected Attributes
TString	fName
Int_t	fSize

Private Member Functions
	TCollection (const TCollection &)=delete
void	operator= (const TCollection &)=delete

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static TCollection *	fgCurrentCollection = nullptr
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgEmptyingGarbage = kFALSE
static TObjectTable *	fgGarbageCollection = nullptr
static Int_t	fgGarbageStack = 0
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

#include <TCollection.h>

Inheritance diagram for TCollection:

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kInitCapacity
kInitHashTableCapacity

Definition at line 159 of file TCollection.h.

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.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 217 of file TCollection.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning: This interface is a legacy function that is no longer recommended to be used by new development code.

Note: The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ Add() [1/2]

virtual void TCollection::Add	(	TObject *	,
		Option_t *	)

inlinevirtual

Reimplemented in TBtree, THashTable, TList, TMap, TObjArray, TQCommand, TQUndoManager, TRefArray, TSeqCollection, and TSortedList.

Definition at line 163 of file TCollection.h.

◆ Add() [2/2]

virtual void TCollection::Add ( TObject * obj )

pure virtual

Implemented in TBtree, THashTable, TList, TMap, TObjArray, TQCommand, TQUndoManager, TRefArray, TSeqCollection, and TSortedList.

◆ AddAll()

void TCollection::AddAll ( const TCollection * col )

virtual

Add all objects from collection col to this collection.

Reimplemented in THashTable.

Definition at line 226 of file TCollection.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.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 239 of file TCollection.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ AssertClass()

Bool_t TCollection::AssertClass ( TClass * cl ) const

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

Definition at line 254 of file TCollection.cxx.

◆ begin()

TIter TCollection::begin ( ) const

inline

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

◆ Capacity()

Int_t TCollection::Capacity ( ) const

inline

Definition at line 168 of file TCollection.h.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * TCollection::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

const char * TCollection::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

constexpr Version_t TCollection::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 224 of file TCollection.h.

◆ ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TCollection::Clear ( Option_t * option = "" )

overridepure virtual

Reimplemented from TObject.

Implemented in TBtree, TClonesArray, THashList, THashTable, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TObjArray, TOrdCollection, TRefArray, TViewPubDataMembers, and TViewPubFunctions.

◆ 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 294 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 306 of file TCollection.cxx.

◆ Contains() [1/2]

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

inline

Definition at line 172 of file TCollection.h.

◆ Contains() [2/2]

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

inline

Definition at line 173 of file TCollection.h.

◆ Copy()

void TObject::Copy ( TObject & object ) const

virtualinherited

Copy this to obj.

Reimplemented in ROOT::v5::TFormula, TArc, TArrow, TAxis3D, TAxis, TBox, TColor, TCrown, TDirectory, TDirectoryFile, TEllipse, TF12, TF1, TF1AbsComposition, TF1Convolution, TF1NormSum, TF2, TF3, TFile, TFolder, TFormula, TFrame, TGTextEdit, TGTextView, TH1, TH1C, TH1D, TH1F, TH1I, TH1L, TH1S, TH2, TH2C, TH2D, TH2F, TH2I, TH2L, TH2Poly, TH2S, TH3, TH3C, TH3D, TH3F, TH3I, TH3L, TH3S, THelix, TLatex, TLegend, TLegendEntry, TLine, TMarker, TMathText, TNamed, TPaletteAxis, TPave, TPaveClass, TPaveLabel, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, TWbox, and TXTRU.

Definition at line 159 of file TObject.cxx.

◆ DeclFileName()

const char * TCollection::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

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

◆ DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive	(	Int_t	px,
		Int_t	py )

virtualinherited

Computes distance from point (px,py) to the object.

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

◆ DoError()

void TObject::DoError	(	int	level,
		const char *	location,
		const char *	fmt,
		va_list	va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

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

overridevirtual

Draw all objects in this collection.

Reimplemented from TObject.

Definition at line 315 of file TCollection.cxx.

◆ DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note: For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TCollection::Dump ( ) const

overridevirtual

Dump all objects in this collection.

Reimplemented from TObject.

Definition at line 328 of file TCollection.cxx.

◆ EmptyGarbageCollection()

void TCollection::EmptyGarbageCollection ( )

static

Do the garbage collection.

Definition at line 741 of file TCollection.cxx.

◆ end()

TIter TCollection::end ( ) const

inline

Definition at line 295 of file TCollection.h.

◆ Error()

void TObject::Error	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute	(	const char *	method,
		const char *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute	(	TMethod *	method,
		TObjArray *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

TObjString

Collectable string class.

Definition TObjString.h:28

n

const Int_t n

Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TObject::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

◆ Fatal()

void TObject::Fatal	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

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

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

Definition at line 368 of file TCollection.cxx.

◆ GarbageCollect()

void TCollection::GarbageCollect ( TObject * obj )

static

Add to the list of things to be cleaned up.

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

◆ GetCurrentCollection()

TCollection * TCollection::GetCurrentCollection ( )

static

Return the globally accessible collection.

Definition at line 711 of file TCollection.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEntries()

virtual Int_t TCollection::GetEntries ( ) const

inlinevirtual

Reimplemented in TObjArray, and TRefArray.

Definition at line 180 of file TCollection.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const

virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

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

◆ GetObjectInfo()

char * TObject::GetObjectInfo	(	Int_t	px,
		Int_t	py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectRef()

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

pure virtual

Implemented in TBtree, THashTable, TList, TListOfEnumsWithLock, TListOfFunctions, TMap, TObjArray, TOrdCollection, TRefArray, TViewPubDataMembers, and TViewPubFunctions.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const

inlinevirtualinherited

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

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

◆ GetTitle()

const char * TObject::GetTitle ( ) const

virtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented in Axis2, TASImage, TAxis, TBaseClass, TClassMenuItem, TEveGeoNode, TEvePointSet, TGaxis, TGGroupFrame, TGLabel, TGLVEntry, TGTextButton, TGTextEntry, TGTextLBEntry, TKey, TMapFile, TNamed, TPad, TPair, TParallelCoordSelect, TParticle, TPaveLabel, TPrimary, TQCommand, TRootIconList, and TVirtualPad.

Definition at line 507 of file TObject.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GrowBy()

Int_t TCollection::GrowBy ( Int_t delta ) const

virtual

Increase the collection's capacity by delta slots.

Definition at line 391 of file TCollection.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.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

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:406

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.

TCollection::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TCollection.h:188

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:1098

TObject::TObject

TObject()

TObject constructor.

Definition TObject.h:259

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 188 of file TCollection.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Info()

void TObject::Info	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TCollection::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TGeoNavigatorArray, THashList, THashTable, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TObjArray, TOrdCollection, TParallelCoordSelect, TQCommand, TQConnection, TQUndoManager, TRefArray, TSeqCollection, and TSortedList.

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

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note: This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns: true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEmpty()

virtual Bool_t TCollection::IsEmpty ( ) const

inlinevirtual

Reimplemented in TObjArray, and TRefArray.

Definition at line 190 of file TCollection.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

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

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

◆ IsOwner()

Bool_t TCollection::IsOwner ( ) const

inline

Definition at line 192 of file TCollection.h.

◆ IsSortable()

Bool_t TCollection::IsSortable ( ) const

inlineoverridevirtual

Reimplemented from TObject.

Definition at line 193 of file TCollection.h.

◆ IsUsingRWLock()

Bool_t TCollection::IsUsingRWLock ( ) const

inline

Definition at line 214 of file TCollection.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.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, TQConnection, TQConnectionList, and TQUndoManager.

Definition at line 413 of file TCollection.cxx.

◆ MakeIterator()

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

pure virtual

Implemented in TBtree, THashTable, TList, TListOfEnumsWithLock, TListOfFunctions, TMap, TObjArray, TOrdCollection, TRefArray, TViewPubDataMembers, and TViewPubFunctions.

◆ MakeReverseIterator()

virtual TIterator * TCollection::MakeReverseIterator ( ) const

inlinevirtual

Definition at line 197 of file TCollection.h.

◆ MakeZombie()

void TObject::MakeZombie ( )

inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method ) const

inherited

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).

Definition at line 1160 of file TObject.cxx.

◆ Notify()

Bool_t TCollection::Notify ( )

overridevirtual

'Notify' all objects in this collection.

Reimplemented from TObject.

Reimplemented in TGTextEditHist.

Definition at line 438 of file TCollection.cxx.

◆ Obsolete()

void TObject::Obsolete	(	const char *	method,
		const char *	asOfVers,
		const char *	removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete	(	void *	ptr,
		size_t	size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[]	(	void *	ptr,
		size_t	size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[]	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new	(	size_t	sz,
		void *	vp )

inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

void * TObject::operator new[]	(	size_t	sz,
		void *	vp )

inlineinherited

Definition at line 192 of file TObject.h.

◆ operator()()

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

Find an object in this collection by name.

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

◆ Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.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.

Definition at line 548 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.

Definition at line 521 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.

Definition at line 581 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:

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:

using TCollection::Print;

TCollection::Print

void Print(Option_t *option="") const override

Default print for collections, calls Print(option, 1).

Definition TCollection.cxx:507

somewhere close to the method declaration.

Reimplemented from TObject.

Reimplemented in THashTable.

Definition at line 507 of file TCollection.cxx.

◆ PrintCollectionEntry()

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

protectedvirtual

Print the collection entry.

Reimplemented in TMap, and TQUndoManager.

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

◆ Read()

Int_t TObject::Read ( const char * name )

virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.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, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TObjArray, TRootBrowserHistory, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 605 of file TCollection.cxx.

◆ Remove()

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

pure virtual

Implemented in TBtree, TClonesArray, THashList, THashTable, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TObjArray, TOrdCollection, TRefArray, TViewPubDataMembers, and TViewPubFunctions.

◆ RemoveAll() [1/2]

void TCollection::RemoveAll ( )

inline

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

◆ ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs	(	const char *	filename = "",
		Option_t *	option = "" ) const

virtualinherited

Save this object in the file specified by filename.

if "filename" contains ".root" the object is saved in filename as root binary file.
if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = "" )

virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor	(	std::ostream &	out,
		TClass *	cl,
		const char *	variable_name,
		const char *	constructor_agrs = "",
		Bool_t	empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw	(	std::ostream &	out,
		const char *	variable_name,
		Option_t *	option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector	(	std::ostream &	out,
		const char *	prefix,
		Int_t	len,
		Double_t *	arr,
		Int_t	flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit	(	UInt_t	f,
		Bool_t	set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetCurrentCollection()

void TCollection::SetCurrentCollection ( )

Set this collection to be the globally accessible collection.

Definition at line 719 of file TCollection.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetName()

void TCollection::SetName ( const char * name )

inline

Definition at line 208 of file TCollection.h.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

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

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ size()

std::size_t TCollection::size ( ) const

inline

Definition at line 181 of file TCollection.h.

◆ StartGarbageCollection()

void TCollection::StartGarbageCollection ( )

static

Set up for garbage collection.

Definition at line 727 of file TCollection.cxx.

◆ Streamer()

void TCollection::Streamer ( TBuffer & b )

overridevirtual

Stream all objects in the collection to or from the I/O buffer.

Reimplemented from TObject.

Reimplemented in TGeoNavigatorArray, THashList, THashTable, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TObjArray, TOrdCollection, TParallelCoordSelect, TQCommand, TQConnection, TQUndoManager, TRefArray, TSeqCollection, and TSortedList.

Definition at line 637 of file TCollection.cxx.

◆ StreamerNVirtual()

void TCollection::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 224 of file TCollection.h.

◆ SysError()

void TObject::SysError	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

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

◆ Warning()

void TObject::Warning	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TCollection::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 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 679 of file TCollection.cxx.

◆ Write() [2/2]

Int_t TCollection::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 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 703 of file TCollection.cxx.

Member Data Documentation

◆ fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fgCurrentCollection

TCollection * TCollection::fgCurrentCollection = nullptr

staticprivate

Definition at line 134 of file TCollection.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.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.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.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.

◆ fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ EDeprecatedStatusBits

◆ EStatusBits

Constructor & Destructor Documentation

◆ TCollection() [1/2]

◆ TCollection() [2/2]

◆ ~TCollection()

Member Function Documentation

◆ AbstractMethod()

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddAll()

◆ AddToTObjectTable()

◆ AddVector()

◆ AppendPad()

◆ AssertClass()

◆ begin()

◆ Browse()

◆ Capacity()

◆ CheckedHash()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClassName()

◆ Clear()

◆ Clone()

◆ Compare()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ Copy()

◆ DeclFileName()

◆ Delete()

◆ DistancetoPrimitive()

◆ DoError()

◆ Draw()

◆ DrawClass()

◆ DrawClone()

◆ Dump()

◆ EmptyGarbageCollection()

◆ end()

◆ Error()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteEvent()

◆ Fatal()

◆ FindObject() [1/2]

◆ FindObject() [2/2]

◆ GarbageCollect()

◆ GetCollectionEntryName()

◆ GetCurrentCollection()

◆ GetDrawOption()

◆ GetDtorOnly()

◆ GetEntries()

◆ GetIconName()

◆ GetName()

◆ GetObjectInfo()

◆ GetObjectRef()

◆ GetObjectStat()

◆ GetOption()

◆ GetSize()

◆ GetTitle()

◆ GetUniqueID()

◆ GrowBy()

◆ HandleTimer()

◆ Hash()