Logo ROOT  
Reference Guide
TEntryList.h
Go to the documentation of this file.
1// @(#)root/tree:$Id$
2// Author: Anna Kreshuk 27/10/2006
3
4/*************************************************************************
5 * Copyright (C) 1995-2006, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TEntryList
13#define ROOT_TEntryList
14
15#include "TNamed.h"
16
17class TTree;
18class TDirectory;
19class TObjArray;
20class TString;
21
22class TList;
23class TCollection;
24
25class TEntryList: public TNamed
26{
27 private:
28 TEntryList& operator=(const TEntryList&); // Not implemented
29
30 protected:
31 TList *fLists; ///< a list of underlying entry lists for each tree of a chain
32 TEntryList *fCurrent; ///<! currently filled entry list
33
34 Int_t fNBlocks; ///< number of TEntryListBlocks
35 TObjArray *fBlocks; ///< blocks with indices of passing events (TEntryListBlocks)
36 Long64_t fN; ///< number of entries in the list
37 Long64_t fEntriesToProcess; ///< used on proof to set the number of entries to process in a packet
38 TString fTreeName; ///< name of the tree
39 TString fFileName; ///< name of the file, where the tree is
40 ULong_t fStringHash; ///<! Hash value of a string of treename and filename
41 Int_t fTreeNumber; ///<! the index of the tree in the chain (used when the entry
42 ///< list is used as input (TTree::SetEntryList())
43
44 Long64_t fLastIndexQueried; ///<! used to optimize GetEntry() function from a loop
45 Long64_t fLastIndexReturned; ///<! used to optimize GetEntry() function from a loop
46 Bool_t fShift; ///<! true when some sub-lists don't correspond to trees
47 ///< (when the entry list is used as input in TChain)
48 TDirectory *fDirectory; ///<! Pointer to directory holding this tree
49 Bool_t fReapply; ///< If true, TTree::Draw will 'reapply' the original cut
50
51 void GetFileName(const char *filename, TString &fn, Bool_t * = 0);
52
53 public:
54 enum {kBlockSize = 64000}; //number of entries in each block (not the physical size).
55
56 TEntryList();
57 TEntryList(const char *name, const char *title);
58 TEntryList(const char *name, const char *title, const TTree *tree);
59 TEntryList(const char *name, const char *title, const char *treename, const char *filename);
60 TEntryList(const TTree *tree);
61 TEntryList(const TEntryList& elist);
62 virtual ~TEntryList();
63
64 virtual void Add(const TEntryList *elist);
65 void AddSubList(TEntryList *elist);
66 virtual Int_t Contains(Long64_t entry, TTree *tree = 0);
67 virtual void DirectoryAutoAdd(TDirectory *);
68 virtual Bool_t Enter(Long64_t entry, TTree *tree = 0);
69 void EnterRange(Long64_t start, Long64_t end, TTree *tree = nullptr, UInt_t step = 1U);
70 virtual TEntryList *GetCurrentList() const { return fCurrent; };
71 virtual TEntryList *GetEntryList(const char *treename, const char *filename, Option_t *opt="");
72 virtual Long64_t GetEntry(Int_t index);
73 virtual Long64_t GetEntryAndTree(Int_t index, Int_t &treenum);
75 virtual TList *GetLists() const { return fLists; }
76 virtual TDirectory *GetDirectory() const { return fDirectory; }
77 virtual Long64_t GetN() const { return fN; }
78 virtual const char *GetTreeName() const { return fTreeName.Data(); }
79 virtual const char *GetFileName() const { return fFileName.Data(); }
80 virtual Int_t GetTreeNumber() const { return fTreeNumber; }
81 virtual Bool_t GetReapplyCut() const { return fReapply; };
82
84 {
85 if ((fLists || fBlocks)) return kTRUE;
86 return kFALSE;
87 }
88
89 virtual Int_t Merge(TCollection *list);
90
91 virtual Long64_t Next();
92 virtual void OptimizeStorage();
93 virtual Int_t RelocatePaths(const char *newloc, const char *oldloc = 0);
94 virtual Bool_t Remove(Long64_t entry, TTree *tree = 0);
95 virtual void Reset();
96 virtual Int_t ScanPaths(TList *roots, Bool_t notify = kTRUE);
97
98 virtual void Print(const Option_t* option = "") const;
99 virtual void SetDirectory(TDirectory *dir);
100 virtual void SetEntriesToProcess(Long64_t nen) { fEntriesToProcess = nen; }
101 virtual void SetShift(Bool_t shift) { fShift = shift; };
102 virtual void SetTree(const TTree *tree);
103 virtual void SetTree(const char *treename, const char *filename);
104 virtual void SetTreeName(const char *treename){ fTreeName = treename; };
105 virtual void SetFileName(const char *filename){ fFileName = filename; };
106 virtual void SetTreeNumber(Int_t index) { fTreeNumber=index; }
107 virtual void SetReapplyCut(Bool_t apply = kFALSE) {fReapply = apply;}; // *TOGGLE* *GETTER=GetReapplyCut
108 virtual void Subtract(const TEntryList *elist);
109
110 static Int_t Relocate(const char *fn,
111 const char *newroot, const char *oldroot = 0, const char *enlnm = 0);
112 static Int_t Scan(const char *fn, TList *roots);
113
114// Preventing warnings with -Weffc++ in GCC since the overloading of the || operator was a design choice.
115#if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 40600
116#pragma GCC diagnostic push
117#pragma GCC diagnostic ignored "-Weffc++"
118#endif
119 friend TEntryList operator||(TEntryList& elist1, TEntryList& elist2);
120#if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 40600
121#pragma GCC diagnostic pop
122#endif
123
124 ClassDef(TEntryList, 2); //A list of entries in a TTree
125};
126#endif
int Int_t
Definition: RtypesCore.h:45
unsigned int UInt_t
Definition: RtypesCore.h:46
const Bool_t kFALSE
Definition: RtypesCore.h:101
unsigned long ULong_t
Definition: RtypesCore.h:55
bool Bool_t
Definition: RtypesCore.h:63
long long Long64_t
Definition: RtypesCore.h:80
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
char name[80]
Definition: TGX11.cxx:110
Collection abstract base class.
Definition: TCollection.h:65
Describe directory structure in memory.
Definition: TDirectory.h:45
A List of entry numbers in a TTree or TChain.
Definition: TEntryList.h:26
Long64_t fLastIndexQueried
! used to optimize GetEntry() function from a loop
Definition: TEntryList.h:44
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...
Definition: TEntryList.cxx:870
Long64_t fEntriesToProcess
used on proof to set the number of entries to process in a packet
Definition: TEntryList.h:37
Bool_t fReapply
If true, TTree::Draw will 'reapply' the original cut.
Definition: TEntryList.h:49
virtual Int_t GetTreeNumber() const
Definition: TEntryList.h:80
TString fFileName
name of the file, where the tree is
Definition: TEntryList.h:39
virtual void OptimizeStorage()
Checks if the array representation is more economical and if so, switches to it.
virtual void SetShift(Bool_t shift)
Definition: TEntryList.h:101
virtual TList * GetLists() const
Definition: TEntryList.h:75
Int_t fTreeNumber
! the index of the tree in the chain (used when the entry list is used as input (TTree::SetEntryList(...
Definition: TEntryList.h:41
virtual void SetReapplyCut(Bool_t apply=kFALSE)
Definition: TEntryList.h:107
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,...
virtual Long64_t GetEntriesToProcess() const
Definition: TEntryList.h:74
TDirectory * fDirectory
! Pointer to directory holding this tree
Definition: TEntryList.h:48
virtual void SetEntriesToProcess(Long64_t nen)
Definition: TEntryList.h:100
virtual TDirectory * GetDirectory() const
Definition: TEntryList.h:76
TObjArray * fBlocks
blocks with indices of passing events (TEntryListBlocks)
Definition: TEntryList.h:35
TEntryList & operator=(const TEntryList &)
virtual Int_t Contains(Long64_t entry, TTree *tree=0)
Definition: TEntryList.cxx:584
virtual const char * GetFileName() const
Definition: TEntryList.h:79
static Int_t Scan(const char *fn, TList *roots)
Scan TEntryList in 'fn' to find the common parts of paths.
virtual void DirectoryAutoAdd(TDirectory *)
Called by TKey and others to automatically add us to a directory when we are read from a file.
Definition: TEntryList.cxx:613
virtual ~TEntryList()
Destructor.
Definition: TEntryList.cxx:323
Long64_t fN
number of entries in the list
Definition: TEntryList.h:36
virtual void SetTreeNumber(Int_t index)
Definition: TEntryList.h:106
Long64_t fLastIndexReturned
! used to optimize GetEntry() function from a loop
Definition: TEntryList.h:45
virtual Bool_t GetReapplyCut() const
Definition: TEntryList.h:81
virtual Long64_t Next()
Return the next non-zero entry index (next after fLastIndexQueried) this function is faster than GetE...
Definition: TEntryList.cxx:979
virtual void SetDirectory(TDirectory *dir)
Add reference to directory dir. dir can be 0.
void EnterRange(Long64_t start, Long64_t end, TTree *tree=nullptr, UInt_t step=1U)
Enter all entries in a range in the TEntryList.
Definition: TEntryList.cxx:684
virtual TEntryList * GetCurrentList() const
Definition: TEntryList.h:70
virtual void SetTreeName(const char *treename)
Definition: TEntryList.h:104
virtual void Reset()
Reset this list.
virtual Bool_t Enter(Long64_t entry, TTree *tree=0)
Add entry #entry to the list.
Definition: TEntryList.cxx:625
virtual Long64_t GetEntry(Int_t index)
Return the number of the entry #index of this TEntryList in the TTree or TChain See also Next().
Definition: TEntryList.cxx:740
Int_t fNBlocks
number of TEntryListBlocks
Definition: TEntryList.h:34
virtual void SetFileName(const char *filename)
Definition: TEntryList.h:105
virtual const char * GetTreeName() const
Definition: TEntryList.h:78
virtual Int_t Merge(TCollection *list)
Merge this list with the lists from the collection.
Definition: TEntryList.cxx:960
TEntryList * fCurrent
! currently filled entry list
Definition: TEntryList.h:32
virtual void Print(const Option_t *option="") const
Print this list.
virtual Long64_t GetEntryAndTree(Int_t index, Int_t &treenum)
Return the index of "index"-th non-zero entry in the TTree or TChain and the # of the corresponding t...
Definition: TEntryList.cxx:816
virtual Int_t RelocatePaths(const char *newloc, const char *oldloc=0)
Relocate the file paths.
virtual Bool_t Remove(Long64_t entry, TTree *tree=0)
Remove entry #entry from the list.
Definition: TEntryList.cxx:698
Bool_t fShift
! true when some sub-lists don't correspond to trees (when the entry list is used as input in TChain)
Definition: TEntryList.h:46
static Int_t Relocate(const char *fn, const char *newroot, const char *oldroot=0, const char *enlnm=0)
Relocate entry list 'enlnm' in file 'fn' replacing 'oldroot' with 'newroot' in filenames.
ULong_t fStringHash
! Hash value of a string of treename and filename
Definition: TEntryList.h:40
Bool_t IsValid() const
Definition: TEntryList.h:83
TList * fLists
a list of underlying entry lists for each tree of a chain
Definition: TEntryList.h:31
virtual Int_t ScanPaths(TList *roots, Bool_t notify=kTRUE)
Scan the paths to find the common roots.
TString fTreeName
name of the tree
Definition: TEntryList.h:38
void AddSubList(TEntryList *elist)
Add a sub entry list to the current list.
Definition: TEntryList.cxx:566
TEntryList()
default c-tor
Definition: TEntryList.cxx:161
virtual void Subtract(const TEntryList *elist)
Remove all the entries of this entry list, that are contained in elist.
virtual void Add(const TEntryList *elist)
Add 2 entry lists.
Definition: TEntryList.cxx:359
friend TEntryList operator||(TEntryList &elist1, TEntryList &elist2)
virtual Long64_t GetN() const
Definition: TEntryList.h:77
A doubly linked list.
Definition: TList.h:44
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
An array of TObjects.
Definition: TObjArray.h:37
Basic string class.
Definition: TString.h:136
const char * Data() const
Definition: TString.h:369
A TTree represents a columnar dataset.
Definition: TTree.h:79
Definition: tree.py:1
TCanvas * roots()
Definition: roots.C:1