Logo ROOT   6.19/01
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 
17 class TTree;
18 class TDirectory;
19 class TObjArray;
20 class TString;
21 
22 class TList;
23 class TCollection;
24 
25 class 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  virtual Int_t Contains(Long64_t entry, TTree *tree = 0);
66  virtual void DirectoryAutoAdd(TDirectory *);
67  virtual Bool_t Enter(Long64_t entry, TTree *tree = 0);
68  virtual TEntryList *GetCurrentList() const { return fCurrent; };
69  virtual TEntryList *GetEntryList(const char *treename, const char *filename, Option_t *opt="");
70  virtual Long64_t GetEntry(Int_t index);
71  virtual Long64_t GetEntryAndTree(Int_t index, Int_t &treenum);
73  virtual TList *GetLists() const { return fLists; }
74  virtual TDirectory *GetDirectory() const { return fDirectory; }
75  virtual Long64_t GetN() const { return fN; }
76  virtual const char *GetTreeName() const { return fTreeName.Data(); }
77  virtual const char *GetFileName() const { return fFileName.Data(); }
78  virtual Int_t GetTreeNumber() const { return fTreeNumber; }
79  virtual Bool_t GetReapplyCut() const { return fReapply; };
80 
81  Bool_t IsValid() const
82  {
83  if ((fLists || fBlocks)) return kTRUE;
84  return kFALSE;
85  }
86 
87  virtual Int_t Merge(TCollection *list);
88 
89  virtual Long64_t Next();
90  virtual void OptimizeStorage();
91  virtual Int_t RelocatePaths(const char *newloc, const char *oldloc = 0);
92  virtual Bool_t Remove(Long64_t entry, TTree *tree = 0);
93  virtual void Reset();
94  virtual Int_t ScanPaths(TList *roots, Bool_t notify = kTRUE);
95 
96  virtual void Print(const Option_t* option = "") const;
97  virtual void SetDirectory(TDirectory *dir);
98  virtual void SetEntriesToProcess(Long64_t nen) { fEntriesToProcess = nen; }
99  virtual void SetShift(Bool_t shift) { fShift = shift; };
100  virtual void SetTree(const TTree *tree);
101  virtual void SetTree(const char *treename, const char *filename);
102  virtual void SetTreeName(const char *treename){ fTreeName = treename; };
103  virtual void SetFileName(const char *filename){ fFileName = filename; };
104  virtual void SetTreeNumber(Int_t index) { fTreeNumber=index; }
105  virtual void SetReapplyCut(Bool_t apply = kFALSE) {fReapply = apply;}; // *TOGGLE* *GETTER=GetReapplyCut
106  virtual void Subtract(const TEntryList *elist);
107 
108  static Int_t Relocate(const char *fn,
109  const char *newroot, const char *oldroot = 0, const char *enlnm = 0);
110  static Int_t Scan(const char *fn, TList *roots);
111 
112 // Preventing warnings with -Weffc++ in GCC since the overloading of the || operator was a design choice.
113 #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 40600
114 #pragma GCC diagnostic push
115 #pragma GCC diagnostic ignored "-Weffc++"
116 #endif
117  friend TEntryList operator||(TEntryList& elist1, TEntryList& elist2);
118 #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 40600
119 #pragma GCC diagnostic pop
120 #endif
121 
122  ClassDef(TEntryList, 2); //A list of entries in a TTree
123 };
124 #endif
virtual void SetEntriesToProcess(Long64_t nen)
Definition: TEntryList.h:98
virtual void SetFileName(const char *filename)
Definition: TEntryList.h:103
Long64_t fEntriesToProcess
used on proof to set the number of entries to process in a packet
Definition: TEntryList.h:37
virtual void SetTreeName(const char *treename)
Definition: TEntryList.h:102
An array of TObjects.
Definition: TObjArray.h:37
virtual Long64_t Next()
Return the next non-zero entry index (next after fLastIndexQueried) this function is faster than GetE...
Definition: TEntryList.cxx:886
virtual TDirectory * GetDirectory() const
Definition: TEntryList.h:74
long long Long64_t
Definition: RtypesCore.h:69
virtual Long64_t GetN() const
Definition: TEntryList.h:75
virtual void SetReapplyCut(Bool_t apply=kFALSE)
Definition: TEntryList.h:105
virtual const char * GetFileName() const
Definition: TEntryList.h:77
const char Option_t
Definition: RtypesCore.h:62
virtual Int_t GetTreeNumber() const
Definition: TEntryList.h:78
Bool_t IsValid() const
Definition: TEntryList.h:81
virtual TList * GetLists() const
Definition: TEntryList.h:73
virtual ~TEntryList()
Destructor.
Definition: TEntryList.cxx:321
Basic string class.
Definition: TString.h:131
virtual void OptimizeStorage()
Checks if the array representation is more economical and if so, switches to it.
Definition: TEntryList.cxx:973
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual void SetShift(Bool_t shift)
Definition: TEntryList.h:99
Int_t fNBlocks
number of TEntryListBlocks
Definition: TEntryList.h:34
TList * fLists
a list of underlying entry lists for each tree of a chain
Definition: TEntryList.h:31
static Int_t Scan(const char *fn, TList *roots)
Scan TEntryList in &#39;fn&#39; to find the common parts of paths.
Long64_t fLastIndexQueried
! used to optimize GetEntry() function from a loop
Definition: TEntryList.h:44
ULong_t fStringHash
! Hash value of a string of treename and filename
Definition: TEntryList.h:40
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...
Bool_t fShift
! true when some sub-lists don&#39;t correspond to trees (when the entry list is used as input in TChain)...
Definition: TEntryList.h:46
TEntryList & operator=(const TEntryList &)
virtual void SetDirectory(TDirectory *dir)
Add reference to directory dir. dir can be 0.
#define ClassDef(name, id)
Definition: Rtypes.h:326
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
virtual Long64_t GetEntriesToProcess() const
Definition: TEntryList.h:72
TCanvas * roots()
Definition: roots.C:1
TDirectory * fDirectory
! Pointer to directory holding this tree
Definition: TEntryList.h:48
A doubly linked list.
Definition: TList.h:44
Bool_t fReapply
If true, TTree::Draw will &#39;reapply&#39; the original cut.
Definition: TEntryList.h:49
virtual void Add(const TEntryList *elist)
Add 2 entry lists.
Definition: TEntryList.cxx:343
TString fTreeName
name of the tree
Definition: TEntryList.h:38
friend TEntryList operator||(TEntryList &elist1, TEntryList &elist2)
TEntryList * fCurrent
! currently filled entry list
Definition: TEntryList.h:32
Collection abstract base class.
Definition: TCollection.h:63
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:653
virtual Int_t Contains(Long64_t entry, TTree *tree=0)
Definition: TEntryList.cxx:517
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:546
virtual Int_t ScanPaths(TList *roots, Bool_t notify=kTRUE)
Scan the paths to find the common roots.
Long64_t fN
number of entries in the list
Definition: TEntryList.h:36
const Bool_t kFALSE
Definition: RtypesCore.h:88
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:729
virtual Int_t Merge(TCollection *list)
Merge this list with the lists from the collection.
Definition: TEntryList.cxx:867
Long64_t fLastIndexReturned
! used to optimize GetEntry() function from a loop
Definition: TEntryList.h:45
Describe directory structure in memory.
Definition: TDirectory.h:34
unsigned long ULong_t
Definition: RtypesCore.h:51
virtual Bool_t GetReapplyCut() const
Definition: TEntryList.h:79
TEntryList()
default c-tor
Definition: TEntryList.cxx:159
virtual Bool_t Enter(Long64_t entry, TTree *tree=0)
Add entry #entry to the list.
Definition: TEntryList.cxx:558
TObjArray * fBlocks
blocks with indices of passing events (TEntryListBlocks)
Definition: TEntryList.h:35
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 TEntryList * GetCurrentList() const
Definition: TEntryList.h:68
virtual void Print(const Option_t *option="") const
Print this list.
Definition: TEntryList.cxx:989
virtual void Reset()
Reset this list.
virtual const char * GetTreeName() const
Definition: TEntryList.h:76
virtual Bool_t Remove(Long64_t entry, TTree *tree=0)
Remove entry #entry from the list.
Definition: TEntryList.cxx:613
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:777
virtual void SetTreeNumber(Int_t index)
Definition: TEntryList.h:104
Definition: tree.py:1
A TTree represents a columnar dataset.
Definition: TTree.h:72
TString fFileName
name of the file, where the tree is
Definition: TEntryList.h:39
static Int_t Relocate(const char *fn, const char *newroot, const char *oldroot=0, const char *enlnm=0)
Relocate entry list &#39;enlnm&#39; in file &#39;fn&#39; replacing &#39;oldroot&#39; with &#39;newroot&#39; in filenames.
A List of entry numbers in a TTree or TChain.
Definition: TEntryList.h:25
const Bool_t kTRUE
Definition: RtypesCore.h:87
virtual void Subtract(const TEntryList *elist)
Remove all the entries of this entry list, that are contained in elist.
char name[80]
Definition: TGX11.cxx:109
virtual Int_t RelocatePaths(const char *newloc, const char *oldloc=0)
Relocate the file paths.
const char * Data() const
Definition: TString.h:364