TList Class Reference

A doubly linked list.

All classes inheriting from TObject can be inserted in a TList. Before being inserted into the list the object pointer is wrapped in a TObjLink object which contains, besides the object pointer also a previous and next pointer.

There are several ways to iterate over a TList; in order of preference, if not forced by other constraints:

1. (Preferred way) Using the C++ range-based for or begin() / end():

   for(TObject *obj: *GetListOfPrimitives())
      obj->Write();

2. Using the R__FOR_EACH macro:

   GetListOfPrimitives()->R__FOR_EACH(TObject,Paint)(option);

3. Using the TList iterator TListIter (via the wrapper class TIter):

   TIter next(GetListOfPrimitives());
   while (TObject *obj = next())
      obj->Draw(next.GetOption());

4. Using the TList iterator TListIter and std::for_each algorithm:

   // A function object, which will be applied to each element
   // of the given range.
   struct STestFunctor {
      bool operator()(TObject *aObj) {
         ...
         return true;
      }
   }
   ...
   ...
   TIter iter(mylist);
   for_each( iter.Begin(), TIter::End(), STestFunctor() );

5. Using the TObjLink list entries (that wrap the TObject*):

   TObjLink *lnk = GetListOfPrimitives()->FirstLink();
   while (lnk) {
      lnk->GetObject()->Draw(lnk->GetOption());
      lnk = lnk->Next();
   }

6. Using the TList's After() and Before() member functions:

   TFree *idcur = this;
   while (idcur) {
      ...
      ...
      idcur = (TFree*)GetListOfFree()->After(idcur);
   }

   Methods 3, 4 and 5 can also easily iterate backwards using either a backward TIter (using argument kIterBackward) or by using LastLink() and lnk->Prev() or by using the Before() member.

Definition at line 38 of file TList.h.

Public Types
typedef TListIter	Iterator_t
Public Types inherited from TCollection
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
	TList ()
virtual	~TList ()
	Delete the list.
void	Add (TObject *obj) override
virtual void	Add (TObject *obj, Option_t *opt)
void	AddAfter (const TObject *after, TObject *obj) override
	Insert object after object after in the list.
virtual void	AddAfter (TObjLink *after, TObject *obj)
	Insert object after the specified ObjLink object.
void	AddAt (TObject *obj, Int_t idx) override
	Insert object at position idx in the list.
void	AddBefore (const TObject *before, TObject *obj) override
	Insert object before object before in the list.
virtual void	AddBefore (TObjLink *before, TObject *obj)
	Insert object before the specified ObjLink object.
void	AddFirst (TObject *obj) override
	Add object at the beginning of the list.
virtual void	AddFirst (TObject *obj, Option_t *opt)
	Add object at the beginning of the list and also store option.
void	AddLast (TObject *obj) override
	Add object at the end of the list.
virtual void	AddLast (TObject *obj, Option_t *opt)
	Add object at the end of the list and also store option.
TObject *	After (const TObject *obj) const override
	Returns the object after object obj.
TObject *	At (Int_t idx) const override
	Returns the object at position idx. Returns 0 if idx is out of range.
TObject *	Before (const TObject *obj) const override
	Returns the object before object obj.
void	Clear (Option_t *option="") override
	Remove all objects from the list.
void	Delete (Option_t *option="") override
	Remove all objects from the list AND delete all heap based objects.
TObject *	FindObject (const char *name) const override
	Find an object in this list using its name.
TObject *	FindObject (const TObject *obj) const override
	Find an object in this list using the object's IsEqual() member function.
TObject *	First () const override
	Return the first object in the list. Returns 0 when list is empty.
virtual TObjLink *	FirstLink () const
TObject **	GetObjectRef (const TObject *obj) const override
	Return address of pointer to obj.
TClass *	IsA () const override
Bool_t	IsAscending ()
TObject *	Last () const override
	Return the last object in the list. Returns 0 when list is empty.
virtual TObjLink *	LastLink () const
TIterator *	MakeIterator (Bool_t dir=kIterForward) const override
	Return a list iterator.
void	RecursiveRemove (TObject *obj) override
	Remove object from this collection and recursively remove the object from all other objects (and collections).
TObject *	Remove (const TObjLinkPtr_t &lnk)
TObject *	Remove (TObject *obj) override
	Remove object from the list.
virtual TObject *	Remove (TObjLink *lnk)
	Remove object link (and therefore the object it contains) from the list.
void	RemoveLast () override
	Remove the last object of the list.
virtual void	Sort (Bool_t order=kSortAscending)
	Sort linked list.
void	Streamer (TBuffer &) override
	Stream all objects in the collection to or from the I/O buffer.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
Public Member Functions inherited from TSeqCollection
virtual	~TSeqCollection ()
void	Add (TObject *obj) override
virtual Int_t	GetLast () const
	Returns index of last object in collection.
virtual Int_t	IndexOf (const TObject *obj) const
	Return index of object in collection.
TClass *	IsA () const override
virtual Bool_t	IsSorted () const
Int_t	LastIndex () const
Long64_t	Merge (TCollection *list)
	Merge this collection with all collections coming in the input list.
virtual void	RemoveAfter (TObject *after)
virtual TObject *	RemoveAt (Int_t idx)
virtual void	RemoveBefore (TObject *before)
virtual void	RemoveFirst ()
void	Streamer (TBuffer &) override
	Stream all objects in the collection to or from the I/O buffer.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
void	UnSort ()
Public Member Functions inherited from TCollection
virtual	~TCollection ()
	TNamed destructor.
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
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
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
virtual Int_t	GetEntries () const
const char *	GetName () const override
	Return name of this collection.
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.
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 TIterator *	MakeReverseIterator () const
Bool_t	Notify () override
	'Notify' all objects in this collection.
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	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	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	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 TObject *	DrawClone (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_t *	GetDrawOption () 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_t *	GetOption () 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, void *vp)
	Only called by placement new when throwing an exception.
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 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 TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
Static Public Member Functions inherited from TSeqCollection
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Int_t	ObjCompare (TObject *a, TObject *b)
	Compare to objects in the collection. Use member Compare() of object a.
static void	QSort (TObject **a, Int_t first, Int_t last)
	Sort array of TObject pointers using a quicksort algorithm.
static void	QSort (TObject **a, Int_t nBs, TObject ***b, Int_t first, Int_t last)
	Sort array a of TObject pointers using a quicksort algorithm.
static void	QSort (TObject **a, TObject **b, Int_t first, Int_t last)
Static Public Member Functions inherited from TCollection
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 void	StartGarbageCollection ()
	Set up for garbage collection.
Static Public Member Functions inherited from TObject
static TClass *	Class ()
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
using	TObjLinkPtr_t = std::shared_ptr< TObjLink >
using	TObjLinkWeakPtr_t = std::weak_ptr< TObjLink >
Protected Types inherited from TCollection
enum	EStatusBits { kIsOwner = (1ULL << ( 14 )) , kUseRWLock = (1ULL << ( 16 )) }
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions
TObjLinkPtr_t *	DoSort (TObjLinkPtr_t *head, Int_t n)
	Sort linked list.
TObjLink *	FindLink (const TObject *obj, Int_t &idx) const
	Returns the TObjLink object that contains object obj.
void	InsertAfter (const TObjLinkPtr_t &newlink, const TObjLinkPtr_t &prev)
	Insert a new link in the chain.
TObjLink *	LinkAt (Int_t idx) const
	sorting order (when calling Sort() or for TSortedList)
Bool_t	LnkCompare (const TObjLinkPtr_t &l1, const TObjLinkPtr_t &l2)
	Compares the objects stored in the TObjLink objects.
TObjLinkPtr_t	NewLink (TObject *obj, const TObjLinkPtr_t &prev=nullptr)
	Return a new TObjLink.
TObjLinkPtr_t	NewLink (TObject *obj, TObjLink *prev)
TObjLinkPtr_t	NewOptLink (TObject *obj, Option_t *opt, const TObjLinkPtr_t &prev=nullptr)
	Return a new TObjOptLink (a TObjLink that also stores the option).
TObjLinkPtr_t	NewOptLink (TObject *obj, Option_t *opt, TObjLink *prev)
Protected Member Functions inherited from TSeqCollection
	TSeqCollection ()
virtual void	Changed ()
Protected Member Functions inherited from TCollection
	TCollection ()
virtual const char *	GetCollectionEntryName (TObject *entry) const
	For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on.
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
Bool_t	fAscending
	cache to speedup sequential calling of Before() and After() functions
TObjLinkWeakPtr_t	fCache
	pointer to last entry in linked list
TObjLinkPtr_t	fFirst
TObjLinkPtr_t	fLast
	pointer to first entry in linked list
Protected Attributes inherited from TSeqCollection
Bool_t	fSorted
Protected Attributes inherited from TCollection
TString	fName
Int_t	fSize

Private Member Functions
	TList (const TList &)=delete
TList &	operator= (const TList &)=delete

Friends
class	TListIter

#include <TList.h>

Inheritance diagram for TList:

Member Typedef Documentation

Iterator_t

typedef TListIter TList::Iterator_t

Definition at line 70 of file TList.h.

TObjLinkPtr_t

using TList::TObjLinkPtr_t = std::shared_ptr<TObjLink>

protected

Definition at line 43 of file TList.h.

TObjLinkWeakPtr_t

using TList::TObjLinkWeakPtr_t = std::weak_ptr<TObjLink>

protected

Definition at line 44 of file TList.h.

Constructor & Destructor Documentation

TList() [1/2]

TList::TList ( const TList &  )

privatedelete

TList() [2/2]

TList::TList ( )

inline

Definition at line 72 of file TList.h.

~TList()

TList::~TList ( )

virtual

Delete the list.

Objects are not deleted unless the TList is the owner (set via SetOwner()).

Definition at line 90 of file TList.cxx.

Member Function Documentation

Add() [1/2]

void TList::Add ( TObject *  obj )

inlineoverridevirtual

Implements TCollection.

Reimplemented in TQCommand, TQUndoManager, and TSortedList.

Definition at line 81 of file TList.h.

Add() [2/2]

virtual void TList::Add ( TObject *  obj, Option_t *  opt  )

inlinevirtual

Reimplemented in TQCommand, TQUndoManager, and TSortedList.

Definition at line 82 of file TList.h.

AddAfter() [1/2]

void TList::AddAfter ( const TObject *  after, TObject *  obj  )

overridevirtual

Insert object after object after in the list.

Implements TSeqCollection.

Reimplemented in TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 248 of file TList.cxx.

AddAfter() [2/2]

void TList::AddAfter ( TObjLink *  after, TObject *  obj  )

virtual

Insert object after the specified ObjLink object.

If after = 0 then add to the tail of the list. An ObjLink can be obtained by looping over a list using the above describe iterator method 3.

Reimplemented in TSortedList, THashList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 280 of file TList.cxx.

AddAt()

void TList::AddAt ( TObject *  obj, Int_t  idx  )

overridevirtual

Insert object at position idx in the list.

Implements TSeqCollection.

Reimplemented in TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TSelectorList, and TSortedList.

Definition at line 304 of file TList.cxx.

AddBefore() [1/2]

void TList::AddBefore ( const TObject *  before, TObject *  obj  )

overridevirtual

Insert object before object before in the list.

Implements TSeqCollection.

Reimplemented in TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 194 of file TList.cxx.

AddBefore() [2/2]

void TList::AddBefore ( TObjLink *  before, TObject *  obj  )

virtual

Insert object before the specified ObjLink object.

If before = 0 then add to the head of the list. An ObjLink can be obtained by looping over a list using the above describe iterator method 3.

Reimplemented in TSortedList, THashList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 226 of file TList.cxx.

AddFirst() [1/2]

void TList::AddFirst ( TObject *  obj )

overridevirtual

Add object at the beginning of the list.

Implements TSeqCollection.

Reimplemented in TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 98 of file TList.cxx.

AddFirst() [2/2]

void TList::AddFirst ( TObject *  obj, Option_t *  opt  )

virtual

Add object at the beginning of the list and also store option.

Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.

Reimplemented in THashList, TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 126 of file TList.cxx.

AddLast() [1/2]

void TList::AddLast ( TObject *  obj )

overridevirtual

Add object at the end of the list.

Implements TSeqCollection.

Reimplemented in TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 150 of file TList.cxx.

AddLast() [2/2]

void TList::AddLast ( TObject *  obj, Option_t *  opt  )

virtual

Add object at the end of the list and also store option.

Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.

Reimplemented in THashList, TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, and TSelectorList.

Definition at line 174 of file TList.cxx.

After()

TObject * TList::After ( const TObject *  obj ) const

overridevirtual

Returns the object after object obj.

Obj is found using the object's IsEqual() method. Returns 0 if obj is last in list.

Implements TSeqCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 328 of file TList.cxx.

At()

TObject * TList::At ( Int_t  idx ) const

overridevirtual

Returns the object at position idx. Returns 0 if idx is out of range.

Implements TSeqCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 355 of file TList.cxx.

Before()

TObject * TList::Before ( const TObject *  obj ) const

overridevirtual

Returns the object before object obj.

Obj is found using the object's IsEqual() method. Returns 0 if obj is first in list.

Implements TSeqCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 369 of file TList.cxx.

Class()

static TClass * TList::Class ( )

static

Returns

TClass describing this class

Class_Name()

static const char * TList::Class_Name ( )

static

Returns

Name of this class

Class_Version()

static constexpr Version_t TList::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 110 of file TList.h.

Clear()

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

overridevirtual

Remove all objects from the list.

Does not delete the objects unless the TList is the owner (set via SetOwner()) and option "nodelete" is not set. If option="nodelete" then don't delete any heap objects that were marked with the kCanDelete bit, otherwise these objects will be deleted (this option is used by THashTable::Clear()).

Implements TCollection.

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

Definition at line 400 of file TList.cxx.

DeclFileName()

static const char * TList::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 110 of file TList.h.

Delete()

void TList::Delete ( Option_t *  option = "" )

overridevirtual

Remove all objects from the list AND delete all heap based objects.

If option="slow" then keep list consistent during delete. This allows recursive list operations during the delete (e.g. during the dtor of an object in this list one can still access the list to search for other not yet deleted objects).

Implements TCollection.

Reimplemented in TQCommand, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 468 of file TList.cxx.

DoSort()

std::shared_ptr< TObjLink > * TList::DoSort ( TObjLinkPtr_t *  head, Int_t  n  )

protected

Sort linked list.

Definition at line 982 of file TList.cxx.

FindLink()

TObjLink * TList::FindLink ( const TObject *  obj, Int_t &  idx  ) const

protected

Returns the TObjLink object that contains object obj.

In idx it returns the position of the object in the list.

Definition at line 626 of file TList.cxx.

FindObject() [1/2]

TObject * TList::FindObject ( const char *  name ) const

overridevirtual

Find an object in this list using its name.

Requires a sequential scan till the object has been found. Returns 0 if object with specified name is not found. This method overrides the generic FindObject() of TCollection for efficiency reasons.

Reimplemented from TCollection.

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

Definition at line 576 of file TList.cxx.

FindObject() [2/2]

TObject * TList::FindObject ( const TObject *  obj ) const

overridevirtual

Find an object in this list using the object's IsEqual() member function.

Requires a sequential scan till the object has been found. Returns 0 if object is not found. This method overrides the generic FindObject() of TCollection for efficiency reasons.

Reimplemented from TCollection.

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

Definition at line 603 of file TList.cxx.

First()

TObject * TList::First ( ) const

overridevirtual

Return the first object in the list. Returns 0 when list is empty.

Implements TSeqCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 657 of file TList.cxx.

FirstLink()

virtual TObjLink * TList::FirstLink ( ) const

inlinevirtual

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 102 of file TList.h.

GetObjectRef()

TObject ** TList::GetObjectRef ( const TObject *  obj ) const

overridevirtual

Return address of pointer to obj.

Implements TCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 669 of file TList.cxx.

InsertAfter()

void TList::InsertAfter ( const TObjLinkPtr_t &  newlink, const TObjLinkPtr_t &  prev  )

protected

Insert a new link in the chain.

Definition at line 1033 of file TList.cxx.

IsA()

TClass * TList::IsA ( ) const

inlineoverridevirtual

Returns

TClass describing current object

Reimplemented from TCollection.

Reimplemented in TQCommand, TQUndoManager, TQConnection, TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, and TParallelCoordSelect.

Definition at line 110 of file TList.h.

IsAscending()

Bool_t TList::IsAscending ( )

inline

Definition at line 108 of file TList.h.

Last()

TObject * TList::Last ( ) const

overridevirtual

Return the last object in the list. Returns 0 when list is empty.

Implements TSeqCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 691 of file TList.cxx.

LastLink()

virtual TObjLink * TList::LastLink ( ) const

inlinevirtual

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 105 of file TList.h.

LinkAt()

TObjLink * TList::LinkAt ( Int_t  idx ) const

protected

sorting order (when calling Sort() or for TSortedList)

Return the TObjLink object at index idx.

Definition at line 703 of file TList.cxx.

LnkCompare()

Bool_t TList::LnkCompare ( const TObjLinkPtr_t &  l1, const TObjLinkPtr_t &  l2  )

protected

Compares the objects stored in the TObjLink objects.

Depending on the flag IsAscending() the function returns true if the object in l1 <= l2 (ascending) or l2 <= l1 (descending).

Definition at line 970 of file TList.cxx.

MakeIterator()

TIterator * TList::MakeIterator ( Bool_t  dir = kIterForward ) const

overridevirtual

Return a list iterator.

Implements TCollection.

Reimplemented in TListOfEnumsWithLock, TListOfFunctions, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 720 of file TList.cxx.

NewLink() [1/2]

TList::TObjLinkPtr_t TList::NewLink ( TObject *  obj, const TObjLinkPtr_t &  prev = nullptr  )

protected

Return a new TObjLink.

Definition at line 731 of file TList.cxx.

NewLink() [2/2]

TList::TObjLinkPtr_t TList::NewLink ( TObject *  obj, TObjLink *  prev  )

inlineprotected

Definition at line 239 of file TList.h.

NewOptLink() [1/2]

TList::TObjLinkPtr_t TList::NewOptLink ( TObject *  obj, Option_t *  opt, const TObjLinkPtr_t &  prev = nullptr  )

protected

Return a new TObjOptLink (a TObjLink that also stores the option).

Definition at line 746 of file TList.cxx.

NewOptLink() [2/2]

TList::TObjLinkPtr_t TList::NewOptLink ( TObject *  obj, Option_t *  opt, TObjLink *  prev  )

inlineprotected

Definition at line 242 of file TList.h.

operator=()

TList & TList::operator= ( const TList &  )

privatedelete

RecursiveRemove()

void TList::RecursiveRemove ( TObject *  obj )

overridevirtual

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

Reimplemented from TCollection.

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

Definition at line 762 of file TList.cxx.

Remove() [1/3]

TObject * TList::Remove ( const TObjLinkPtr_t &  lnk )

inline

Definition at line 94 of file TList.h.

Remove() [2/3]

TObject * TList::Remove ( TObject *  obj )

overridevirtual

Remove object from the list.

Implements TCollection.

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

Definition at line 820 of file TList.cxx.

Remove() [3/3]

TObject * TList::Remove ( TObjLink *  lnk )

virtual

Remove object link (and therefore the object it contains) from the list.

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

Definition at line 868 of file TList.cxx.

RemoveLast()

void TList::RemoveLast ( )

overridevirtual

Remove the last object of the list.

Reimplemented from TSeqCollection.

Definition at line 907 of file TList.cxx.

Sort()

void TList::Sort ( Bool_t  order = kSortAscending )

virtual

Sort linked list.

Real sorting is done in private function DoSort(). The list can only be sorted when is contains objects of a sortable class.

Reimplemented in TSortedList.

Definition at line 935 of file TList.cxx.

Streamer()

void TList::Streamer ( TBuffer &  b )

overridevirtual

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

Reimplemented from TCollection.

Reimplemented in TQCommand, TQUndoManager, TQConnection, TSortedList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, and TParallelCoordSelect.

Definition at line 1189 of file TList.cxx.

StreamerNVirtual()

void TList::StreamerNVirtual ( TBuffer &  ClassDef_StreamerNVirtual_b )

inline

Definition at line 110 of file TList.h.

Friends And Related Symbol Documentation

TListIter

friend class TListIter

friend

Definition at line 40 of file TList.h.

Member Data Documentation

fAscending

Bool_t TList::fAscending

protected

cache to speedup sequential calling of Before() and After() functions

Definition at line 49 of file TList.h.

fCache

TObjLinkWeakPtr_t TList::fCache

protected

pointer to last entry in linked list

Definition at line 48 of file TList.h.

fFirst

TObjLinkPtr_t TList::fFirst

protected

Definition at line 46 of file TList.h.

fLast

TObjLinkPtr_t TList::fLast

protected

pointer to first entry in linked list

Definition at line 47 of file TList.h.

Libraries for TList:

---

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

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