A List of entry numbers in a TTree or TChain.

Note: It is recommended to use approaches such as TTreeReader::SetEntryRange or ROOT::RDataFrame instead of TEntryList if possible.

Operations on entry lists

Add() - if the lists are for the same tree, adds all the entries of the second list to the first list. If the lists are for different trees, creates a TEntryList with 2 sublists for each TTree. If the lists are for TChains, merges the ones for the same trees and adds new sublists for the TTrees that were not included in the first TEntryList
Subtract() - if the lists are for the same TTree, removes the entries of the second list from the first list. If the lists are for TChains, loops over all sub-lists
GetEntry(n) - returns the n-th entry number
Next() - returns next entry number. Note, that this function is much faster than GetEntry, and it's called when GetEntry() is called for 2 or more indices in a row.

TTree::Draw() and TChain::Draw()

Use option entrylist to write the results of TTree::Draw and TChain::Draw into an entry list. Example:

tree->Draw(">>elist", "x<0 && y>0", "entrylist");

TEntryList *elist = (TEntryList*)gDirectory->Get("elist");

gDirectory

#define gDirectory

Definition TDirectory.h:385

TEntryList

A List of entry numbers in a TTree or TChain.

Definition TEntryList.h:26

Example of Loop on TEntryList with a TChain

void loopChain() {
   TFile *fe = TFile::Open("myelist.root");
   TEntryList *myelist = (TEntryList*)fe->Get("myelist");
   TChain *chain = new TChain("ntuple");
   chain->Add("hsimple.root");
   chain->Add("hsimple2.root");
   Long64_t listEntries = myelist->GetN();
   Long64_t chainEntries = chain->GetEntries();
   Int_t treenum = 0;
   chain->SetEntryList(myelist);
 
   for (entry=start;entry < end;entry++) {
      entryNumber = chain->GetEntryNumber(entry);
      if (entryNumber < 0) break;
      localEntry = chain->LoadTree(entryNumber);
      if (localEntry < 0) break;
      ....
      then either call
         branch->GetEntry(localEntry);
      or
         chain->GetEntry(entryNumber);
      In the later case the LoadTree is then somewhat redundant.
      ...
   }
}

When using the TEntryList interface directly, you can get the 'tree number' and entry in the current tree (i.e. value similar to the return value of LoadTree) from calling TEntryList::GetEntryAndTree:

Long64_t treeEntry = myelist->GetEntryAndTree(el,treenum);

to obtain the entry number within the chain you need to add to it the value of treeEntry+ch->GetTreeOffset()[treenum] such that the loop in the previous example can also be written as:

for (Long64_t el = 0; el < listEntries; el++) {
   Long64_t treeEntry = myelist->GetEntryAndTree(el,treenum);
   Long64_t chainEntry = treeEntry+ch->GetTreeOffset()[treenum];
   printf("el=%lld, treeEntry=%lld, chainEntry=%lld, treenum=%d\n", el, treeEntry, chainEntry, treenum);
 
   ch->LoadTree(chainEntry); // this also returns treeEntry
   needed_branch->GetEntry(treeEntry);
}

TSelectors

To fill an TEntryList from a TSelector correctly, one must add the TEntryList object to the output list of the selector (TSelector::fOutput). This is the only way to make the sub-lists of the TEntryList switch when the current tree of the TChain is changed.

Using a TEntryList as input (TTree::SetEntryList() and TChain::SetEntryList())

while the TTree::SetEntryList() function is only setting the TTree::fEntryList data member, the same function in TChain also finds correspondence between the TTrees of this TChain and the sub-lists of this TEntryList.

TEntryList and the current directory

TEntryList objects are automatically added to the current directory (like TTrees). However, in case of a TEntryList for a chain, only the top-level entry list is added, not the sub-lists for specific trees. Placing entry lists in the current directory allows calling them as a part of a TTreeFormula expression, so if the user wants to extract a sublist from a TChain entry list via the GetEntryList() or some other function, they have to add it to the current directory to be able to use it in TTreeFormula expressions.

TEntryList and TEventList

TTree::SetEventList() and TChain::SetEventList() transform a TEventList into a TEntryList See comments to those functions for more details

Types of entry lists

There are two types of entry lists:

1.

for a TTree (fBlocks data member is non-zero) Entry numbers are stored in TEntryListBlocks, which, in their turn, are stored in the TObjArray fBlocks. The range of the entry numbers is cut into intervals of kBlockSize entries (currently 64000), so that the first block contains information which entries out of the first 64000 pass the selection, the second block - which entries out of the 64000-127999 interval pass the selection, etc. Some blocks, obviously, might be empty. The internal representation of entry numbers in the blocks is described in the TEntryListBlock class description, and this representation might be changed by calling OptimizeStorage() function (when the list is filled via the Enter() function, this is done automatically, except for the last block). Individual entry lists can be merged (functions Merge() and Add()) to make an entry list for a TChain of corresponding TTrees.

2.

for a TChain (fLists data member is non-zero) It contains a TList of sub-lists (TEntryList objects, corresponding to each TTree) Trees and lists are matched by the TTree name and its file name (full path). All sub-lists are returned by the GetLists() function and individual lists are returned by GetEntryList() function. Such lists are no different from the lists for TTrees, described above.

Definition at line 25 of file TEntryList.h.

Public Types
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kBlockSize = 64000 }

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
	TEntryList ()
	default c-tor

	TEntryList (const char name, const char title)
	c-tor with name and title

	TEntryList (const char name, const char title, const char treename, const char filename)
	c-tor with name and title, which also sets the treename and the filename

	TEntryList (const char name, const char title, const TTree *tree)
	constructor with name and title, which also sets the tree

	TEntryList (const TEntryList &elist)
	copy c-tor

	TEntryList (const TTree *tree)
	c-tor, which sets the tree

	~TEntryList () override
	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 (const TEntryList *elist)
	Add 2 entry lists.

void	AddSubList (TEntryList *elist)
	Add a sub entry list to the current list.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

virtual Int_t	Contains (Long64_t entry, TTree *tree=nullptr)

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual void	DirectoryAutoAdd (TDirectory *)
	Called by TKey and others to automatically add us to a directory when we are read from a file.

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

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

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	Dump () const
	Dump contents of object on stdout.

virtual bool	Enter (Long64_t entry, TTree *tree=nullptr)
	Add entry #entry to the list.

virtual bool	Enter (Long64_t localentry, const char treename, const char filename)

void	EnterRange (Long64_t start, Long64_t end, TTree *tree=nullptr, UInt_t step=1U)
	Enter all entries in a range in the TEntryList.

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 void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual TEntryList *	GetCurrentList () const

virtual TDirectory *	GetDirectory () const

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual Long64_t	GetEntriesToProcess () const

virtual Long64_t	GetEntry (Long64_t index)
	Return the number of the entry #index of this TEntryList in the TTree or TChain See also Next().

virtual Long64_t	GetEntryAndTree (Long64_t index, Int_t &treenum)
	Return the index of "index"-th non-zero entry in the TTree or TChain and the # of the corresponding tree in the chain.

virtual TEntryList *	GetEntryList (const char treename, const char filename, Option_t *opt="")
	Return the entry list, corresponding to treename and filename By default, the filename is first tried as is, and then, if the corresponding list is not found, the filename is expanded to the absolute path, and compared again.

virtual const char *	GetFileName () const

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual TList *	GetLists () const

virtual Long64_t	GetN () const

const char *	GetName () const override
	Returns 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 bool	GetReapplyCut () const

const char *	GetTitle () const override
	Returns title of object.

virtual const char *	GetTreeName () const

virtual Int_t	GetTreeNumber () const

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.

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

Bool_t	IsSortable () const override

bool	IsValid () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	ls (Option_t *option="") const override
	List TNamed name and title.

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

virtual Int_t	Merge (TCollection *list)
	Merge this list with the lists from the collection.

virtual Long64_t	Next ()
	Return the next non-zero entry index (next after fLastIndexQueried) this function is faster than GetEntry()

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

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)

virtual void	OptimizeStorage ()
	Checks if the array representation is more economical and if so, switches to it.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

void	Print (const Option_t *option="") const override
	Print this list.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

virtual Int_t	RelocatePaths (const char newloc, const char oldloc=nullptr)
	Relocate the file paths.

virtual bool	Remove (Long64_t entry, TTree *tree=nullptr)
	Remove entry #entry from the list.

virtual void	Reset ()
	Reset this list.

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

virtual Int_t	ScanPaths (TList *roots, bool notify=true)
	Scan the paths to find the common roots.

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	SetDirectory (TDirectory *dir)
	Add reference to directory dir. dir can be 0.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetEntriesToProcess (Long64_t nen)

virtual void	SetFileName (const char *filename)

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetReapplyCut (bool apply=false)

virtual void	SetShift (bool shift)

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual void	SetTree (const char treename, const char filename)
	If a list for a tree with such name and filename exists, sets it as the current sublist If not, creates this list and sets it as the current sublist.

virtual void	SetTree (const TTree *tree)
	If a list for a tree with such name and filename exists, sets it as the current sublist If not, creates this list and sets it as the current sublist The name of the file, where the tree is, is taken as `tree->GetTree()->GetCurrentFile()->GetName()`, and then expanded either to the absolute path, or to full url.

virtual void	SetTreeName (const char *treename)

virtual void	SetTreeNumber (Int_t index)

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Custom streamer for class TEntryList to handle the different interpretation of fFileName between version 1 and >1 .

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	Subtract (const TEntryList *elist)
	Remove all the entries of this entry list, that are contained in elist.

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.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
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 Int_t	Relocate (const char fn, const char newroot, const char oldroot=nullptr, const char enlnm=nullptr)
	Relocate entry list 'enlnm' in file 'fn' replacing 'oldroot' with 'newroot' in filenames.

static Int_t	Scan (const char fn, TList roots)
	Scan TEntryList in 'fn' to find the common parts of paths.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	GetFileName (const char filename, TString &fn, bool =nullptr)
	To be able to re-localize the entry-list we identify the file by just the name and the anchor, i.e.

void	MakeZombie ()

void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".

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
TObjArray *	fBlocks
	blocks with indices of passing events (TEntryListBlocks)

TEntryList *	fCurrent
	! currently filled entry list

TDirectory *	fDirectory
	! Pointer to directory holding this tree

Long64_t	fEntriesToProcess
	used on proof to set the number of entries to process in a packet

TString	fFileName
	name of the file, where the tree is

Long64_t	fLastIndexQueried
	! used to optimize GetEntry() function from a loop

Long64_t	fLastIndexReturned
	! used to optimize GetEntry() function from a loop

TList *	fLists
	a list of underlying entry lists for each tree of a chain

Long64_t	fN
	number of entries in the list

TString	fName

Int_t	fNBlocks
	number of TEntryListBlocks

bool	fReapply
	If true, TTree::Draw will 'reapply' the original cut.

bool	fShift
	! true when some sub-lists don't correspond to trees (when the entry list is used as input in TChain)

ULong_t	fStringHash
	! Hash value of a string of treename and filename

TString	fTitle

TString	fTreeName
	name of the tree

Int_t	fTreeNumber
	! the index of the tree in the chain (used when the entry list is used as input (TTree::SetEntryList())

Private Member Functions
TEntryList &	operator= (const TEntryList &)

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 Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)

static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

Friends
TEntryList	operator\|\| (TEntryList &elist1, TEntryList &elist2)

#include <TEntryList.h>

Inheritance diagram for TEntryList:

Member Enumeration Documentation

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

◆ anonymous enum

anonymous enum

Enumerator
kBlockSize

Definition at line 54 of file TEntryList.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

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.

◆ EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits

inherited

Enumerator
kCanDelete	if object in a list can be deleted
kMustCleanup	if object destructor must call RecursiveRemove()
kIsReferenced	if object is referenced by a TRef or TRefArray
kHasUUID	if object has a TUUID (its fUniqueID=UUIDNumber)
kCannotPick	if object in a pad cannot be picked
kNoContextMenu	if object does not want context menu
kInvalidObject	if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TEntryList() [1/6]

TEntryList::TEntryList ( )

default c-tor

Definition at line 166 of file TEntryList.cxx.

◆ TEntryList() [2/6]

TEntryList::TEntryList	(	const char *	name,
		const char *	title )

c-tor with name and title

Definition at line 187 of file TEntryList.cxx.

◆ TEntryList() [3/6]

TEntryList::TEntryList	(	const char *	name,
		const char *	title,
		const TTree *	tree )

constructor with name and title, which also sets the tree

Definition at line 213 of file TEntryList.cxx.

◆ TEntryList() [4/6]

TEntryList::TEntryList	(	const char *	name,
		const char *	title,
		const char *	treename,
		const char *	filename )

c-tor with name and title, which also sets the treename and the filename

Definition at line 235 of file TEntryList.cxx.

◆ TEntryList() [5/6]

TEntryList::TEntryList ( const TTree * tree )

c-tor, which sets the tree

Definition at line 257 of file TEntryList.cxx.

◆ TEntryList() [6/6]

TEntryList::TEntryList ( const TEntryList & elist )

copy c-tor

Definition at line 280 of file TEntryList.cxx.

◆ ~TEntryList()

TEntryList::~TEntryList ( )

override

Destructor.

Definition at line 328 of file TEntryList.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()

void TEntryList::Add ( const TEntryList * elist )

virtual

Add 2 entry lists.

Parameters

[in] elist The list that should be added to the current one.

Note: If you are creating a TEntryList for a TChain and you would like to have a one to one mapping between the sub lists of the TEntryList and the sub trees in the TChain, please do not call this function but use TEntryList::AddSubList instead and pair it with a call to TChain::SetEntryList with option "sync". See the AddSubList function documentation for an example usage. This helps for example in a testing or benchmark scenario where a TChain holds multiple times the same tree in the same file. In that case, this function would not be be able to distinguish different sub entry lists that refer to the same treename and filename. Instead it would create a union of all the sub entry lists into one list.

Reimplemented in TEntryListFromFile, and TEntryListArray.

Definition at line 364 of file TEntryList.cxx.

◆ AddSubList()

void TEntryList::AddSubList ( TEntryList * elist )

Add a sub entry list to the current list.

Parameters

[in] elist an entry list that should be added as a sub list of this list.

This function is specifically targeted at situations where there is a global TEntryList that should hold one or more sub TEntryList objects. For example, if one wants to create a one to one mapping between the sub entry lists and the trees in the files that make a TChain. Note that in such cases this configuration of the entry list should be used in pair with the option "sync" of the function TChain::SetEntryList

// Create a TChain with two files. Each contains a tree with 20 entries
TChain chain{"entries"};
chain.Add("file_20entries_1.root");
chain.Add("file_20entries_2.root");
 
// Create a global, empty TEntryList.
TEntryList elists;
// Create two entry lists. Each one will be referring to a different tree in the chain
TEntryList elist1{"","","entries","file_20entries_1.root"};
TEntryList elist2{"","","entries","file_20entries_2.root"};
 
// Select the first ten entries from the first tree and all entries from the second
for(auto entry = 0; entry < 10; entry++){
    elist1.Enter(entry);
}
for(auto entry = 0; entry < 20; entry++){
    elist2.Enter(entry);
}
 
// Add sub entry lists to the global list
elists.AddSubList(&elist1);
elists.AddSubList(&elist2);
 
// Set the entry list in the chain. Note the usage of option "sync"
chain.SetEntryList(&elists, "sync");

Definition at line 571 of file TEntryList.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.

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

◆ Browse()

void TObject::Browse ( TBrowser * b )

virtualinherited

Browse object. May be overridden for another default action.

Reimplemented in TASImage, TRecorder, TEfficiency, TGraph2D, TChain, TTree, TDirectory, TFolder, TMacro, TRemoteObject, TROOT, TStyle, TSystemDirectory, TSystemFile, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookBranch, THbookFile, THbookKey, TF1, TGraph, TH1, THnBase, ROOT::Internal::THnBaseBrowsable, THStack, TMultiDimFit, TMultiGraph, TPrincipal, TDirectoryFile, TKey, TKeyMapFile, TMapFile, TSPlot, TDatabasePDG, TGenerator, TParticleClassPDG, TApplicationRemote, RooPlot, TBranch, TVirtualBranchBrowsable, TCollectionPropertyBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TLeaf, TNtuple, TNtupleD, TTreePerfStats, and ROOT::Experimental::XRooFit::xRooNode.

Definition at line 218 of file TObject.cxx.

◆ 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()

static TClass * TEntryList::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TEntryList::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TEntryList::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 125 of file TEntryList.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 TNamed::Clear ( Option_t * option = "" )

overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TStreamerInfo, TVirtualStreamerInfo, TProcessID, TTask, TPrincipal, and TVirtualFitter.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "" ) const

overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj ) const

overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Contains()

Int_t TEntryList::Contains	(	Long64_t	entry,
		TTree *	tree = nullptr )

virtual

When tree = 0, returns from the current list
When tree != 0, finds the list, corresponding to this tree
When tree is a chain, the entry is assumed to be global index and the local entry is recomputed from the treeoffset information of the chain

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 589 of file TEntryList.cxx.

◆ Copy()

void TNamed::Copy ( TObject & named ) const

overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TSystemDirectory, TSystemFile, TProfile, TProfile2D, TProfile3D, TPieSlice, TStyle, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

◆ DeclFileName()

static const char * TEntryList::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 125 of file TEntryList.h.

◆ Delete()

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

virtualinherited

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented in TDirectory, TDirectoryFile, TFile, TSystemDirectory, TSystemFile, TTreeViewer, TGItemContext, TCanvas, TGFrame, TGTextEdit, TAxis, RooLinkedList, TExMap, TObjectTable, TProtoClass, TKeySQL, TKeyXML, TQCommand, TBtree, TClonesArray, THashList, THashTable, TList, TMap, TObjArray, TOrdCollection, TRefArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TThread, TKey, TMVA::Results, TTree, and TCollection.

Definition at line 268 of file TObject.cxx.

◆ DirectoryAutoAdd()

void TEntryList::DirectoryAutoAdd ( TDirectory * dir )

virtual

Called by TKey and others to automatically add us to a directory when we are read from a file.

Definition at line 618 of file TEntryList.cxx.

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

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 TTreeViewer, and TThread.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

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

virtualinherited

Default Draw method for all objects.

Reimplemented in TClassTree, ROOT::RGeoPainter, TGListTree, TGPicture, TMultiDimFit, TRatioPlot, TGraph, TGraphTime, THStack, TMultiGraph, TChain, TTree, TFITSHDU, TEfficiency, RooStats::HypoTestInverterPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TGeoParallelWorld, TDirectory, TCollection, TBrowser, TClass, TGeoBatemanSol, TGeoNode, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoVolume, TGeoOverlap, TGeoPainter, TGeoTrack, TGeoVGShape, TASImage, TButton, TCanvas, TColorWheel, TPad, TArrow, TBox, TDiamond, TEllipse, TFrame, TLegend, TMarker, TPave, TPaveLabel, TPavesText, TPaveText, TPolyLine, TWbox, TGraphStruct, TEveGeoNode, TEveGeoTopNode, TGeometry, THelix, TNode, TNodeDiv, TPolyLine3D, TPolyMarker3D, TStructViewer, TStructViewerGUI, TF1, TF2, TF3, TH1, TPolyMarker, TSpline, TFile, TMatrixTBase< Element >, TMatrixTBase< AReal >, TMatrixTBase< Double_t >, TVectorT< Element >, TVectorT< Double_t >, TMultiLayerPerceptron, TGenerator, RooAbsData, TTreePerfStats, TParallelCoordVar, TGItemContext, TVirtualPad, TPie, TGraph2D, TGraphPolar, TGraphPolargram, TParallelCoord, TParallelCoordRange, TSpider, RooPlot, and RooStats::SamplingDistPlot.

Definition at line 293 of file TObject.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 TSystemDirectory, TSystemFile, and TGFrame.

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 TSystemDirectory, TSystemFile, TGFrame, TAxis, and TCanvas.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TSystemFile, TCollection, TClass, TGFrame, and TGPack.

Definition at line 367 of file TObject.cxx.

◆ Enter() [1/2]

bool TEntryList::Enter	(	Long64_t	entry,
		TTree *	tree = nullptr )

virtual

Add entry #entry to the list.

When tree = 0, adds to the current list
When tree != 0, finds the list, corresponding to this tree
When tree is a chain, the entry is assumed to be global index and the local entry is recomputed from the treeoffset information of the chain

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 630 of file TEntryList.cxx.

◆ Enter() [2/2]

bool TEntryList::Enter	(	Long64_t	localentry,
		const char *	treename,
		const char *	filename )

virtual

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 678 of file TEntryList.cxx.

◆ EnterRange()

void TEntryList::EnterRange	(	Long64_t	start,
		Long64_t	end,
		TTree *	tree = nullptr,
		UInt_t	step = 1U )

Enter all entries in a range in the TEntryList.

Parameters

[in]	start	starting entry to enter.
[in]	end	ending entry to enter.
[in]	tree	passed as is to TEntryList::Enter.
[in]	step	step increase of the loop entering the entries.

This is a helper function that enters all entries between start (inclusive) and end (exclusive) to the TEntryList in a loop. It is useful also in PyROOT to avoid having to do the same in a Python loop.

Definition at line 702 of file TEntryList.cxx.

◆ 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 TMethodCall, TCling, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

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 TCling, TMethodCall, TInterpreter, ROOT::R::TRInterface, and TContextMenu.

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

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.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer )

virtualinherited

Encode TNamed into output buffer.

Reimplemented in TKeySQL, TSQLFile, TKeyXML, TXMLFile, TDirectoryFile, TFile, and TKey.

Definition at line 103 of file TNamed.cxx.

◆ FindObject() [1/2]

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

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in TListOfEnums, TMap, TDirectory, TFolder, TROOT, TListOfTypes, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

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

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in TMap, TDirectory, TFolder, TROOT, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.

Definition at line 435 of file TObject.cxx.

◆ GetCurrentList()

virtual TEntryList * TEntryList::GetCurrentList ( ) const

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 71 of file TEntryList.h.

◆ GetDirectory()

virtual TDirectory * TEntryList::GetDirectory ( ) const

inlinevirtual

Definition at line 77 of file TEntryList.h.

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

◆ GetEntriesToProcess()

virtual Long64_t TEntryList::GetEntriesToProcess ( ) const

inlinevirtual

Definition at line 75 of file TEntryList.h.

◆ GetEntry()

Long64_t TEntryList::GetEntry ( Long64_t index )

virtual

Return the number of the entry #index of this TEntryList in the TTree or TChain See also Next().

Reimplemented in TEntryListFromFile.

Definition at line 758 of file TEntryList.cxx.

◆ GetEntryAndTree()

Long64_t TEntryList::GetEntryAndTree	(	Long64_t	index,
		Int_t &	treenum )

virtual

Return the index of "index"-th non-zero entry in the TTree or TChain and the # of the corresponding tree in the chain.

Reimplemented in TEntryListFromFile.

Definition at line 834 of file TEntryList.cxx.

◆ GetEntryList()

TEntryList * TEntryList::GetEntryList	(	const char *	treename,
		const char *	filename,
		Option_t *	opt = "" )

virtual

Return the entry list, corresponding to treename and filename By default, the filename is first tried as is, and then, if the corresponding list is not found, the filename is expanded to the absolute path, and compared again.

To avoid it, use option "ne"

Reimplemented in TEntryListFromFile.

Definition at line 888 of file TEntryList.cxx.

◆ GetFileName() [1/2]

virtual const char * TEntryList::GetFileName ( ) const

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 80 of file TEntryList.h.

◆ GetFileName() [2/2]

void TEntryList::GetFileName	(	const char *	filename,
		TString &	fn,
		bool *	local = nullptr )

protected

To be able to re-localize the entry-list we identify the file by just the name and the anchor, i.e.

we drop protocol, host, options, ... The result in the form 'file::anchor' (or 'file', if no anchor is present) is saved in 'fn'. The function optionally (is 'local' is defined) checks file locality (i.e. protocol 'file://') returning the result in '*local' .

Definition at line 869 of file TEntryList.cxx.

◆ 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 TSystemFile, TGeoVolume, TASImage, TGMainFrame, TKey, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TMethodBrowsable, and TBranchElement.

Definition at line 472 of file TObject.cxx.

◆ GetLists()

virtual TList * TEntryList::GetLists ( ) const

inlinevirtual

Definition at line 76 of file TEntryList.h.

◆ GetN()

virtual Long64_t TEntryList::GetN ( ) const

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 78 of file TEntryList.h.

◆ GetName()

const char * TNamed::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ 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 TGeoNode, TGeoVolume, TGeoTrack, TASImage, TColorWheel, TAxis3D, TNode, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TF1, TF2, TGraph, TH1, THistPainter, TPaletteAxis, TFileDrawMap, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ 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 TGeoVolume, TArrow, TGaxis, TLegendEntry, TPave, TPolyLine, TAxis3D, THelix, TNode, TPolyLine3D, TPolyMarker3D, TH1, TPolyMarker, TFile, TMapFile, TPSocket, TSocket, TUDPSocket, TSelector, and TPoints3DABC.

Definition at line 147 of file TObject.h.

◆ GetReapplyCut()

virtual bool TEntryList::GetReapplyCut ( ) const

inlinevirtual

Definition at line 82 of file TEntryList.h.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const

inlineoverridevirtualinherited

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 from TObject.

Definition at line 50 of file TNamed.h.

◆ GetTreeName()

virtual const char * TEntryList::GetTreeName ( ) const

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 79 of file TEntryList.h.

◆ GetTreeNumber()

virtual Int_t TEntryList::GetTreeNumber ( ) const

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 81 of file TEntryList.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.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 TGWindow, TGuiBldDragManager, TGraphTime, TGLEventHandler, TGCommandPlugin, TGDNDManager, TGFileContainer, TGPopupMenu, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGHtml, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const

inlineoverridevirtualinherited

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.

TNamed::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TNamed.h:51

TObject

Mother of all ROOT objects.

Definition TObject.h:42

TObject::Error

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

Issue error message.

Definition TObject.cxx:1098

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 51 of file TNamed.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 TSystemFile, TInspectorObject, TGFrame, and ROOT::Experimental::XRooFit::xRooNode.

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 * TEntryList::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 125 of file TEntryList.h.

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

◆ 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 TObjString, TQCommand, TPair, and TGObject.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

Bool_t TObject::IsFolder ( ) const

virtualinherited

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

Reimplemented in TDirectory, TFolder, TRemoteObject, TROOT, TSystemDirectory, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoNodeMatrix, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookFile, THbookKey, THnBase, ROOT::Internal::THnBaseBrowsable, TMultiDimFit, TPrincipal, TKey, TMapFile, TSPlot, TDatabasePDG, TParticleClassPDG, TApplicationRemote, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and TTree.

Definition at line 579 of file TObject.cxx.

◆ IsOnHeap()

R__ALWAYS_INLINE Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsValid()

bool TEntryList::IsValid ( ) const

inline

Definition at line 84 of file TEntryList.h.

◆ IsZombie()

R__ALWAYS_INLINE Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TNamed::ls ( Option_t * option = "" ) const

overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TVirtualStreamerInfo, TROOT, TStreamerElement, TStreamerBase, TStreamerSTL, TText, TStreamerInfo, TTask, and TNode.

Definition at line 112 of file TNamed.cxx.

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

◆ Merge()

Int_t TEntryList::Merge ( TCollection * list )

virtual

Merge this list with the lists from the collection.

Reimplemented in TEntryListFromFile.

Definition at line 978 of file TEntryList.cxx.

◆ Next()

Long64_t TEntryList::Next ( )

virtual

Return the next non-zero entry index (next after fLastIndexQueried) this function is faster than GetEntry()

Reimplemented in TEntryListFromFile.

Definition at line 997 of file TEntryList.cxx.

◆ Notify()

Bool_t TObject::Notify ( )

virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TFileHandler, TSignalHandler, TStdExceptionHandler, TProcessEventTimer, TTimer, TIdleTimer, TSingleShotCleaner, TCollection, TRefTable, TBrowserTimer, TInterruptHandler, TTermInputHandler, TThreadTimer, TGLRedrawTimer, TViewTimer, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TViewUpdateTimer, TPopupDelayTimer, TRepeatTimer, TSBRepeatTimer, TGTextEditHist, TInsCharCom, TDelCharCom, TBreakLineCom, TInsTextCom, TDelTextCom, TBlinkTimer, TTipDelayTimer, TGuiBldDragManagerRepeatTimer, TARInterruptHandler, TASLogHandler, TASInterruptHandler, TASSigPipeHandler, TASInputHandler, TSocketHandler, TTimeOutTimer, TBranchElement, TBranchRef, TLeafObject, TSelector, TTree, TSelectorDraw, TSelectorEntries, TTreeFormula, TTreeFormulaManager, TTreeReader, h1analysis, h1analysisTreeReader, and TSysEvtHandler.

Definition at line 618 of file TObject.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=()

TEntryList & TEntryList::operator= ( const TEntryList & )

private

◆ OptimizeStorage()

void TEntryList::OptimizeStorage ( )

virtual

Checks if the array representation is more economical and if so, switches to it.

Reimplemented in TEntryListFromFile.

Definition at line 1084 of file TEntryList.cxx.

◆ Paint()

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

virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in TPie, TSQLFile, TXMLFile, ROOT::RGeoPainter, TGaxis, TGraph, TGraphTime, THStack, TMultiGraph, TScatter, TScatter2D, TTreePerfStats, ROOT::Experimental::RTreeMapPainter, TEfficiency, TRatioPlot, TGeoBoolNode, TGeoUnion, TGeoIntersection, TGeoSubtraction, TMarker3DBox, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2DPainter, TSpectrum2Painter, TFileDrawMap, TDirectory, TExec, TMacro, TStyle, TBits, TCollection, TGeoNode, TGeoPhysicalNode, TGeoShape, TGeoVolume, TGeoOverlap, TGeoPainter, TGeoTrack, TGeoVGShape, TASImage, TASPaletteEditor::PaintPalette, TASPaletteEditor::LimitLine, TAnnotation, TButton, TCanvas, TClassTree, TColorWheel, TPad, TArrow, TBox, TCrown, TDiamond, TEllipse, TFrame, TLatex, TLegend, TLine, TMarker, TMathText, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPolyLine, TText, TWbox, TGraphEdge, TGraphNode, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoTopNode, TEveGeoShape, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TAxis3D, TNode, TNodeDiv, TPolyLine3D, TPolyMarker3D, TShape, TF1, TF2, TF3, TGraph2D, TH1, TPolyMarker, TSpline, THistPainter, TPaletteAxis, TFile, TGenerator, TParticle, TPrimary, TParallelCoordVar, TVirtualPad, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TParallelCoordRange, TSpider, TGraphPolargram, and TParallelCoord.

Definition at line 631 of file TObject.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 TPad, TFrame, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print() [1/2]

void TEntryList::Print ( const Option_t * option = "" ) const

override

Print this list.

option = "" - default - print the name of the tree and file
option = "all" - print all the entry numbers

Definition at line 1100 of file TEntryList.cxx.

◆ Print() [2/2]

void TNamed::Print ( Option_t * option = "" ) const

overridevirtualinherited

Print TNamed name and title.

Reimplemented from TObject.

Reimplemented in TSQLFile, TXMLFile, TScatter, TScatter2D, TParticleClassPDG, TParticlePDG, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TPrincipal, TText, TXTRU, TSpectrum, TSpectrum2, TSpectrum3, TSQLColumnInfo, TSQLTableInfo, TTree, TTreeIndex, TParallelCoordVar, and TParallelCoordRange.

Definition at line 127 of file TNamed.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 TKeyXML, TBuffer, TKey, and TKeySQL.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

void TObject::RecursiveRemove ( TObject * obj )

virtualinherited

Recursively remove this object from a list.

Typically implemented by classes that can contain multiple references to a same object.

Reimplemented in THistPainter, TCling, TDirectory, TFolder, TProcessID, TROOT, TCollection, THashList, TList, TObjArray, TBrowser, TObjectSpy, TObjectRefSpy, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, TViewPubDataMembers, TViewPubFunctions, TDialogCanvas, TInspectCanvas, TPad, TLegend, TGeometry, TNode, ROOT::RBrowserDataCleanup, TFitEditor, TGedEditor, TH1Editor, TH2Editor, TGFileBrowser, TRootBrowser, TRootBrowserLite, TRootContextMenu, TRootBrowserHistory, TEfficiency, TGraph, TGraph2D, TH1, THStack, TMultiGraph, TFileMerger, RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, RooWorkspace, TChain, TFriendElement, TTree, TTreePlayer, and TVirtualPad.

Definition at line 684 of file TObject.cxx.

◆ Relocate()

Int_t TEntryList::Relocate	(	const char *	fn,
		const char *	newroot,
		const char *	oldroot = nullptr,
		const char *	enlnm = nullptr )

static

Relocate entry list 'enlnm' in file 'fn' replacing 'oldroot' with 'newroot' in filenames.

If 'enlnm' is null or '*' all entry lists in the file are relocated. Relocation is mandatory to use the entry-list with the same dataset at a different location (i.e. on a different cluster, machine or disks). This function can be called as many times as need to reach the desired result. The existing 'locations' can be checked qith TEntryList::Scan .

Definition at line 1465 of file TEntryList.cxx.

◆ RelocatePaths()

Int_t TEntryList::RelocatePaths	(	const char *	newroot,
		const char *	oldroot = nullptr )

virtual

Relocate the file paths.

If oldroot is defined, replace oldroot with newroot in all file names, i.e. oldroot/re/st/of/the/path will become newroot/re/st/of/the/path. Ifoldrootis null, the new path will be justnewroot/path`. Relocation is mandatory to use the entry-list with the same dataset at a different location (i.e. on a different cluster, machine or disks).

Definition at line 1406 of file TEntryList.cxx.

◆ Remove()

bool TEntryList::Remove	(	Long64_t	entry,
		TTree *	tree = nullptr )

virtual

Remove entry #entry from the list.

When tree = 0, removes from the current list
When tree != 0, finds the list, corresponding to this tree
When tree is a chain, the entry is assumed to be global index and the local entry is recomputed from the treeoffset information of the chain

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 716 of file TEntryList.cxx.

◆ Reset()

void TEntryList::Reset ( )

virtual

Reset this list.

Reimplemented in TEntryListArray.

Definition at line 1137 of file TEntryList.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 TSpline, TFolder, TGeoVolume, TClassTree, TPad, TPaveClass, TGObject, TSpline3, TSpline5, ROOT::Experimental::XRooFit::xRooNode, TTreePerfStats, TVirtualPad, TGraph, and TH1.

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

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.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle	(	std::ostream &	out,
		const char *	variable_name )

protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.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.

◆ Scan()

Int_t TEntryList::Scan	(	const char *	fn,
		TList *	roots )

static

Scan TEntryList in 'fn' to find the common parts of paths.

If 'roots' is defined, add the found roots to the list as TObjStrings. Return the number of common root paths found.

Definition at line 1608 of file TEntryList.cxx.

◆ ScanPaths()

Int_t TEntryList::ScanPaths	(	TList *	roots,
		bool	notify = true )

virtual

Scan the paths to find the common roots.

If 'roots' is defined, add the found roots to the list as TObjStrings. Return the number of roots found.

Definition at line 1551 of file TEntryList.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.

◆ SetDirectory()

void TEntryList::SetDirectory ( TDirectory * dir )

virtual

Add reference to directory dir. dir can be 0.

Definition at line 1169 of file TEntryList.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 TSystemDirectory, TSystemFile, TPad, TGFrame, TAxis, TBrowser, TPaveStats, TGedFrame, TRootBrowserLite, and RooPlot.

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.

◆ SetEntriesToProcess()

virtual void TEntryList::SetEntriesToProcess ( Long64_t nen )

inlinevirtual

Definition at line 101 of file TEntryList.h.

◆ SetFileName()

virtual void TEntryList::SetFileName ( const char * filename )

inlinevirtual

Definition at line 106 of file TEntryList.h.

◆ SetName()

void TNamed::SetName ( const char * name )

virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TEveScene, TColor, TSystemDirectory, TSystemFile, TNode, TRotMatrix, TShape, TEfficiency, TFormula, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TEventList, TTree, TGraph, and TDirectory.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle	(	const char *	name,
		const char *	title )

virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TContextMenu, TNode, TGraph2D, TH1, RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, and TGraph.

Definition at line 163 of file TNamed.cxx.

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

◆ SetReapplyCut()

virtual void TEntryList::SetReapplyCut ( bool apply = false )

inlinevirtual

Definition at line 108 of file TEntryList.h.

◆ SetShift()

virtual void TEntryList::SetShift ( bool shift )

inlinevirtual

Definition at line 102 of file TEntryList.h.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "" )

virtualinherited

Set the title of the TNamed.

Reimplemented in ROOT::TSchemaRule::TSources, TParallelCoordVar, RooPlot, TSystemDirectory, TSystemFile, TEfficiency, TH1, THnBase, ROOT::Experimental::XRooFit::xRooNode, Axis2, TASImage, TF1, TGraph, and TGraph2D.

Definition at line 173 of file TNamed.cxx.

◆ SetTree() [1/2]

void TEntryList::SetTree	(	const char *	treename,
		const char *	filename )

virtual

If a list for a tree with such name and filename exists, sets it as the current sublist If not, creates this list and sets it as the current sublist.

! the filename is taken as provided, no extensions to full path or url !

Reimplemented in TEntryListFromFile, and TEntryListArray.

Definition at line 1183 of file TEntryList.cxx.

◆ SetTree() [2/2]

void TEntryList::SetTree ( const TTree * tree )

virtual

If a list for a tree with such name and filename exists, sets it as the current sublist If not, creates this list and sets it as the current sublist The name of the file, where the tree is, is taken as tree->GetTree()->GetCurrentFile()->GetName(), and then expanded either to the absolute path, or to full url.

If, for some reason, you want to provide the filename in a different format, use SetTree(const char *treename, const char *filename), where the filename is taken "as is".

Reimplemented in TEntryListFromFile, and TEntryListArray.

Definition at line 1295 of file TEntryList.cxx.

◆ SetTreeName()

virtual void TEntryList::SetTreeName ( const char * treename )

inlinevirtual

Definition at line 105 of file TEntryList.h.

◆ SetTreeNumber()

virtual void TEntryList::SetTreeNumber ( Int_t index )

inlinevirtual

Reimplemented in TEntryListFromFile.

Definition at line 107 of file TEntryList.h.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const

virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TDirectoryFile, TFile, and TKey.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TEntryList::Streamer ( TBuffer & b )

overridevirtual

Custom streamer for class TEntryList to handle the different interpretation of fFileName between version 1 and >1 .

Reimplemented from TObject.

Reimplemented in TEntryListArray, and TEntryListFromFile.

Definition at line 1643 of file TEntryList.cxx.

◆ StreamerNVirtual()

void TEntryList::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 125 of file TEntryList.h.

◆ Subtract()

void TEntryList::Subtract ( const TEntryList * elist )

virtual

Remove all the entries of this entry list, that are contained in elist.

Reimplemented in TEntryListFromFile, and TEntryListArray.

Definition at line 1332 of file TEntryList.cxx.

◆ 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()

R__ALWAYS_INLINE 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 TCanvas, TPad, TFrame, TPaveStats, TPaveText, TAxis3D, TGraph, TH1, and TTree.

Definition at line 909 of file TObject.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 TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, ROOT::TBufferMergerFile, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
The TBuffer object is filled via the class::Streamer function.
If the file is compressed (default) a second buffer is created to hold the compressed buffer.
Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.

Definition at line 964 of file TObject.cxx.

Friends And Related Symbol Documentation

◆ operator||

TEntryList operator\|\|	(	TEntryList &	elist1,
		TEntryList &	elist2 )

friend

Definition at line 1385 of file TEntryList.cxx.

Member Data Documentation

◆ fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBlocks

TObjArray* TEntryList::fBlocks

protected

blocks with indices of passing events (TEntryListBlocks)

Definition at line 35 of file TEntryList.h.

◆ fCurrent

TEntryList* TEntryList::fCurrent

protected

! currently filled entry list

Definition at line 32 of file TEntryList.h.

◆ fDirectory

TDirectory* TEntryList::fDirectory

protected

! Pointer to directory holding this tree

Definition at line 48 of file TEntryList.h.

◆ fEntriesToProcess

Long64_t TEntryList::fEntriesToProcess

protected

used on proof to set the number of entries to process in a packet

Definition at line 37 of file TEntryList.h.

◆ fFileName

TString TEntryList::fFileName

protected

name of the file, where the tree is

Definition at line 39 of file TEntryList.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.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fLastIndexQueried

Long64_t TEntryList::fLastIndexQueried

protected

! used to optimize GetEntry() function from a loop

Definition at line 44 of file TEntryList.h.

◆ fLastIndexReturned

Long64_t TEntryList::fLastIndexReturned

protected

! used to optimize GetEntry() function from a loop

Definition at line 45 of file TEntryList.h.

◆ fLists

TList* TEntryList::fLists

protected

a list of underlying entry lists for each tree of a chain

Definition at line 31 of file TEntryList.h.

◆ fN

Long64_t TEntryList::fN

protected

number of entries in the list

Definition at line 36 of file TEntryList.h.

◆ fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNBlocks

Int_t TEntryList::fNBlocks

protected

number of TEntryListBlocks

Definition at line 34 of file TEntryList.h.

◆ fReapply

bool TEntryList::fReapply

protected

If true, TTree::Draw will 'reapply' the original cut.

Definition at line 49 of file TEntryList.h.

◆ fShift

bool TEntryList::fShift

protected

! true when some sub-lists don't correspond to trees (when the entry list is used as input in TChain)

Definition at line 46 of file TEntryList.h.

◆ fStringHash

ULong_t TEntryList::fStringHash

protected

! Hash value of a string of treename and filename

Definition at line 40 of file TEntryList.h.

◆ fTitle

TString TNamed::fTitle

protectedinherited

Definition at line 33 of file TNamed.h.

◆ fTreeName

TString TEntryList::fTreeName

protected

name of the tree

Definition at line 38 of file TEntryList.h.

◆ fTreeNumber

Int_t TEntryList::fTreeNumber

protected

! the index of the tree in the chain (used when the entry list is used as input (TTree::SetEntryList())

Definition at line 41 of file TEntryList.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:

tree/tree/inc/TEntryList.h
tree/tree/src/TEntryList.cxx

Operations on entry lists

TTree::Draw() and TChain::Draw()

Example of Loop on TEntryList with a TChain

TSelectors

Using a TEntryList as input (TTree::SetEntryList() and TChain::SetEntryList())

TEntryList and the current directory

TEntryList and TEventList

Types of entry lists

1.

2.

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

Friends

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ EDeprecatedStatusBits

◆ EStatusBits

Constructor & Destructor Documentation

◆ TEntryList() [1/6]

◆ TEntryList() [2/6]

◆ TEntryList() [3/6]

◆ TEntryList() [4/6]

◆ TEntryList() [5/6]

◆ TEntryList() [6/6]

◆ ~TEntryList()

Member Function Documentation

◆ AbstractMethod()

◆ Add()

◆ AddSubList()

◆ AddToTObjectTable()

◆ AppendPad()

◆ Browse()

◆ CheckedHash()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClassName()

◆ Clear()

◆ Clone()

◆ Compare()

◆ Contains()

◆ Copy()

◆ DeclFileName()

◆ Delete()

◆ DirectoryAutoAdd()

◆ DistancetoPrimitive()

◆ DoError()

◆ Draw()

◆ DrawClass()

◆ DrawClone()

◆ Dump()

◆ Enter() [1/2]

◆ Enter() [2/2]

◆ EnterRange()

◆ Error()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteEvent()

◆ Fatal()

◆ FillBuffer()

◆ FindObject() [1/2]

◆ FindObject() [2/2]

◆ GetCurrentList()

◆ GetDirectory()

◆ GetDrawOption()

◆ GetDtorOnly()

◆ GetEntriesToProcess()

◆ GetEntry()