Logo ROOT   6.19/01
Reference Guide
TBranch.h
Go to the documentation of this file.
1 // @(#)root/tree:$Id$
2 // Author: Rene Brun 12/01/96
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, 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_TBranch
13 #define ROOT_TBranch
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TBranch //
19 // //
20 // A TTree object is a list of TBranchs. //
21 // A TBranch describes the branch data structure and supports : //
22 // the list of TBaskets (branch buffers) associated to this branch. //
23 // the list of TLeaves (branch description) //
24 //////////////////////////////////////////////////////////////////////////
25 
26 #include <memory>
27 
28 #include "Compression.h"
29 #include "TAttFill.h"
30 #include "TBranchCacheInfo.h"
31 #include "TDataType.h"
32 #include "TNamed.h"
33 #include "TObjArray.h"
34 #include "ROOT/TIOFeatures.hxx"
35 
36 class TTree;
37 class TBasket;
38 class TLeaf;
39 class TBrowser;
40 class TDirectory;
41 class TFile;
42 class TClonesArray;
43 class TTreeCloner;
44 class TTreeCache;
45 
46 namespace ROOT {
47 namespace Experimental {
48 namespace Internal {
49 class TBulkBranchRead;
50 }
51 }
52 namespace Internal {
53 class TBranchIMTHelper; ///< A helper class for managing IMT work during TTree:Fill operations.
54 }
55 }
56 
57 const Int_t kDoNotProcess = BIT(10); // Active bit for branches
58 const Int_t kIsClone = BIT(11); // to indicate a TBranchClones
59 const Int_t kBranchObject = BIT(12); // branch is a TObject*
60 const Int_t kBranchAny = BIT(17); // branch is an object*
62 
63 namespace ROOT {
64 namespace Experimental {
65 namespace Internal {
66 
67 ///\class TBulkBranchRead
68 /// Helper class for reading many branch entries at once to optimize throughput.
70 
71  friend class ::TBranch;
72 
73 public:
74  Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf);
76  Int_t GetEntriesSerialized(Long64_t evt, TBuffer &user_buf, TBuffer *count_buf);
77  Bool_t SupportsBulkRead() const;
78 
79 private:
81  : fParent(parent)
82  {}
83 
85 };
86 }
87 }
88 }
89 
90 class TBranch : public TNamed , public TAttFill {
92 
93 protected:
94  friend class TTreeCache;
95  friend class TTreeCloner;
96  friend class TTree;
98 
99  // TBranch status bits
100  enum EStatusBits {
101  kDoNotProcess = ::kDoNotProcess, // Active bit for branches
102  kIsClone = ::kIsClone, // to indicate a TBranchClones
103  kBranchObject = ::kBranchObject, // branch is a TObject*
104  kBranchAny = ::kBranchAny, // branch is an object*
105  // kMapObject = kBranchObject | kBranchAny;
107 
108  kDoNotUseBufferMap = BIT(22) // If set, at least one of the entry in the branch will use the buffer's map of classname and objects.
109  };
110 
112  static Int_t fgCount; ///<! branch counter
113  Int_t fCompress; ///< Compression level and algorithm
114  Int_t fBasketSize; ///< Initial Size of Basket Buffer
115  Int_t fEntryOffsetLen; ///< Initial Length of fEntryOffset table in the basket buffers
116  Int_t fWriteBasket; ///< Last basket number written
117  Long64_t fEntryNumber; ///< Current entry number (last one filled in this branch)
118  TBasket *fExtraBasket; ///<! Allocated basket not currently holding any data.
119  TIOFeatures fIOFeatures; ///< IO features for newly-created baskets.
120  Int_t fOffset; ///< Offset of this branch
121  Int_t fMaxBaskets; ///< Maximum number of Baskets so far
122  Int_t fNBaskets; ///<! Number of baskets in memory
123  Int_t fSplitLevel; ///< Branch split level
124  Int_t fNleaves; ///<! Number of leaves
125  Int_t fReadBasket; ///<! Current basket number when reading
126  Long64_t fReadEntry; ///<! Current entry number when reading
127  Long64_t fFirstBasketEntry; ///<! First entry in the current basket.
128  Long64_t fNextBasketEntry; ///<! Next entry that will requires us to go to the next basket
129  TBasket *fCurrentBasket; ///<! Pointer to the current basket.
130  Long64_t fEntries; ///< Number of entries
131  Long64_t fFirstEntry; ///< Number of the first entry in this branch
132  Long64_t fTotBytes; ///< Total number of bytes in all leaves before compression
133  Long64_t fZipBytes; ///< Total number of bytes in all leaves after compression
134  TObjArray fBranches; ///< -> List of Branches of this branch
135  TObjArray fLeaves; ///< -> List of leaves of this branch
136  TObjArray fBaskets; ///< -> List of baskets of this branch
137  Int_t *fBasketBytes; ///<[fMaxBaskets] Length of baskets on file
138  Long64_t *fBasketEntry; ///<[fMaxBaskets] Table of first entry in each basket
139  Long64_t *fBasketSeek; ///<[fMaxBaskets] Addresses of baskets on file
140  TTree *fTree; ///<! Pointer to Tree header
141  TBranch *fMother; ///<! Pointer to top-level parent branch in the tree.
142  TBranch *fParent; ///<! Pointer to parent branch.
143  char *fAddress; ///<! Address of 1st leaf (variable or object)
144  TDirectory *fDirectory; ///<! Pointer to directory where this branch buffers are stored
145  TString fFileName; ///< Name of file where buffers are stored ("" if in same file as Tree header)
146  TBuffer *fEntryBuffer; ///<! Buffer used to directly pass the content without streaming
147  TBuffer *fTransientBuffer; ///<! Pointer to the current transient buffer.
148  TList *fBrowsables; ///<! List of TVirtualBranchBrowsables used for Browse()
149  BulkObj fBulk; ///<! Helper for performing bulk IO
150 
151  Bool_t fSkipZip; ///<! After being read, the buffer will not be unzipped.
152 
154  CacheInfo_t fCacheInfo; ///<! Hold info about which basket are in the cache and if they have been retrieved from the cache.
155 
157  ReadLeaves_t fReadLeaves; ///<! Pointer to the ReadLeaves implementation to use.
159  FillLeaves_t fFillLeaves; ///<! Pointer to the FillLeaves implementation to use.
160  void ReadLeavesImpl(TBuffer &b);
161  void ReadLeaves0Impl(TBuffer &b);
162  void ReadLeaves1Impl(TBuffer &b);
163  void ReadLeaves2Impl(TBuffer &b);
164  void FillLeavesImpl(TBuffer &b);
165 
166  void SetSkipZip(Bool_t skip = kTRUE) { fSkipZip = skip; }
167  void Init(const char *name, const char *leaflist, Int_t compress);
168 
169  TBasket *GetFreshBasket(TBuffer *user_buffer);
171  Int_t WriteBasket(TBasket* basket, Int_t where) { return WriteBasketImpl(basket, where, nullptr); }
172 
173  TString GetRealFileName() const;
174 
175 private:
176  Int_t GetBasketAndFirst(TBasket*& basket, Long64_t& first, TBuffer* user_buffer);
177  TBasket *GetBasketImpl(Int_t basket, TBuffer* user_buffer);
179  Int_t GetEntriesSerialized(Long64_t N, TBuffer& user_buf) {return GetEntriesSerialized(N, user_buf, nullptr);}
181  Int_t FillEntryBuffer(TBasket* basket,TBuffer* buf, Int_t& lnew);
183  TBranch(const TBranch&) = delete; // not implemented
184  TBranch& operator=(const TBranch&) = delete; // not implemented
185 
186 public:
187  TBranch();
188  TBranch(TTree *tree, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
189  TBranch(TBranch *parent, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
190  virtual ~TBranch();
191 
192  virtual void AddBasket(TBasket &b, Bool_t ondisk, Long64_t startEntry);
193  virtual void AddLastBasket(Long64_t startEntry);
194  Int_t BackFill();
195  virtual void Browse(TBrowser *b);
196  virtual void DeleteBaskets(Option_t* option="");
197  virtual void DropBaskets(Option_t *option = "");
198  void ExpandBasketArrays();
199  Int_t Fill() { return FillImpl(nullptr); }
201  virtual TBranch *FindBranch(const char *name);
202  virtual TLeaf *FindLeaf(const char *name);
204  Int_t FlushOneBasket(UInt_t which);
205 
206  virtual char *GetAddress() const {return fAddress;}
207  TBasket *GetBasket(Int_t basket) {return GetBasketImpl(basket, nullptr);}
208  Int_t *GetBasketBytes() const {return fBasketBytes;}
210  virtual Long64_t GetBasketSeek(Int_t basket) const;
211  virtual Int_t GetBasketSize() const {return fBasketSize;}
213  virtual TList *GetBrowsables();
214  virtual const char* GetClassName() const;
216  Int_t GetCompressionLevel() const;
218  TDirectory *GetDirectory() const {return fDirectory;}
219  virtual Int_t GetEntry(Long64_t entry=0, Int_t getall = 0);
220  virtual Int_t GetEntryExport(Long64_t entry, Int_t getall, TClonesArray *list, Int_t n);
222  Int_t GetEvent(Long64_t entry=0) {return GetEntry(entry);}
223  const char *GetIconName() const;
224  virtual Int_t GetExpectedType(TClass *&clptr,EDataType &type);
225  virtual TLeaf *GetLeaf(const char *name) const;
226  virtual TFile *GetFile(Int_t mode=0);
227  const char *GetFileName() const {return fFileName.Data();}
228  Int_t GetOffset() const {return fOffset;}
229  Int_t GetReadBasket() const {return fReadBasket;}
230  Long64_t GetReadEntry() const {return fReadEntry;}
232  Long64_t GetTotalSize(Option_t *option="") const;
233  Long64_t GetTotBytes(Option_t *option="") const;
234  Long64_t GetZipBytes(Option_t *option="") const;
236  Long64_t GetFirstEntry() const {return fFirstEntry; }
237  TIOFeatures GetIOFeatures() const;
241  Int_t GetMaxBaskets() const {return fMaxBaskets;}
242  Int_t GetNleaves() const {return fNleaves;}
243  Int_t GetSplitLevel() const {return fSplitLevel;}
244  Long64_t GetEntries() const {return fEntries;}
245  TTree *GetTree() const {return fTree;}
246  virtual Int_t GetRow(Int_t row);
247  virtual Bool_t GetMakeClass() const;
248  TBranch *GetMother() const;
249  TBranch *GetSubBranch(const TBranch *br) const;
251  Bool_t IsAutoDelete() const;
252  Bool_t IsFolder() const;
253  virtual void KeepCircular(Long64_t maxEntries);
254  virtual Int_t LoadBaskets();
255  virtual void Print(Option_t *option="") const;
256  void PrintCacheInfo() const;
257  virtual void ReadBasket(TBuffer &b);
258  virtual void Refresh(TBranch *b);
259  virtual void Reset(Option_t *option="");
260  virtual void ResetAfterMerge(TFileMergeInfo *);
261  virtual void ResetAddress();
262  virtual void ResetReadEntry() {fReadEntry = -1;}
263  virtual void SetAddress(void *add);
264  virtual void SetObject(void *objadd);
265  virtual void SetAutoDelete(Bool_t autodel=kTRUE);
266  virtual void SetBasketSize(Int_t buffsize);
267  virtual void SetBufferAddress(TBuffer *entryBuffer);
271  virtual void SetEntries(Long64_t entries);
272  virtual void SetEntryOffsetLen(Int_t len, Bool_t updateSubBranches = kFALSE);
273  virtual void SetFirstEntry( Long64_t entry );
274  virtual void SetFile(TFile *file=0);
275  virtual void SetFile(const char *filename);
276  void SetIOFeatures(TIOFeatures &features) {fIOFeatures = features;}
277  virtual Bool_t SetMakeClass(Bool_t decomposeObj = kTRUE);
278  virtual void SetOffset(Int_t offset=0) {fOffset=offset;}
279  virtual void SetStatus(Bool_t status=1);
280  virtual void SetTree(TTree *tree) { fTree = tree;}
281  virtual void SetupAddresses();
282  Bool_t SupportsBulkRead() const;
283  virtual void UpdateAddress() {;}
284  virtual void UpdateFile();
285 
286  static void ResetCount();
287 
288  ClassDef(TBranch, 13); // Branch descriptor
289 };
290 
291 //______________________________________________________________________________
293 {
294  return (fCompress < 0) ? -1 : fCompress / 100;
295 }
296 
297 //______________________________________________________________________________
299 {
300  return (fCompress < 0) ? -1 : fCompress % 100;
301 }
302 
303 //______________________________________________________________________________
305 {
306  return (fCompress < 0) ? -1 : fCompress;
307 }
308 
309 namespace ROOT {
310 namespace Experimental {
311 namespace Internal {
312 
313 inline Int_t TBulkBranchRead::GetBulkEntries(Long64_t evt, TBuffer& user_buf) { return fParent.GetBulkEntries(evt, user_buf); }
315 inline Int_t TBulkBranchRead::GetEntriesSerialized(Long64_t evt, TBuffer& user_buf, TBuffer* count_buf) { return fParent.GetEntriesSerialized(evt, user_buf, count_buf); }
317 
318 } // Internal
319 } // Experimental
320 } // ROOT
321 
322 #endif
virtual void UpdateAddress()
Definition: TBranch.h:283
void Init(const char *name, const char *leaflist, Int_t compress)
Definition: TBranch.cxx:295
Int_t fNBaskets
! Number of baskets in memory
Definition: TBranch.h:122
virtual const char * GetClassName() const
Return the name of the user class whose content is stored in this branch, if any. ...
Definition: TBranch.cxx:1300
A TLeaf describes individual elements of a TBranch See TBranch structure in TTree.
Definition: TLeaf.h:49
virtual void SetBufferAddress(TBuffer *entryBuffer)
Set address of this branch directly from a TBuffer to avoid streaming.
Definition: TBranch.cxx:2558
An array of TObjects.
Definition: TObjArray.h:37
Long64_t * GetBasketEntry() const
Definition: TBranch.h:209
virtual Int_t FillImpl(ROOT::Internal::TBranchIMTHelper *)
Loop on all leaves of this branch to fill Basket buffer.
Definition: TBranch.cxx:833
virtual void UpdateFile()
Refresh the value of fDirectory (i.e.
Definition: TBranch.cxx:3113
virtual void SetAddress(void *add)
Set address of this branch.
Definition: TBranch.cxx:2495
Bool_t SupportsBulkRead() const
Returns true if this branch supports bulk IO, false otherwise.
Definition: TBranch.cxx:1400
Int_t GetSplitLevel() const
Definition: TBranch.h:243
Int_t fOffset
Offset of this branch.
Definition: TBranch.h:120
long long Long64_t
Definition: RtypesCore.h:69
virtual Int_t GetBasketSize() const
Definition: TBranch.h:211
VSD Structures.
Definition: StringConv.hxx:21
TObjArray * GetListOfBaskets()
Definition: TBranch.h:238
virtual ~TBranch()
Destructor.
Definition: TBranch.cxx:440
Long64_t fEntries
Number of entries.
Definition: TBranch.h:130
Int_t FlushOneBasket(UInt_t which)
If we have a write basket in memory and it contains some entries and has not yet been written to disk...
Definition: TBranch.cxx:1158
virtual Int_t GetExpectedType(TClass *&clptr, EDataType &type)
Fill expectedClass and expectedType with information on the data type of the object/values contained ...
Definition: TBranch.cxx:1707
Int_t GetCompressionLevel() const
Definition: TBranch.h:298
const char Option_t
Definition: RtypesCore.h:62
Long64_t GetZipBytes(Option_t *option="") const
Return total number of zip bytes in the branch if option ="*" includes all sub-branches of this branc...
Definition: TBranch.cxx:2051
Long64_t fZipBytes
Total number of bytes in all leaves after compression.
Definition: TBranch.h:133
ReadLeaves_t fReadLeaves
! Pointer to the ReadLeaves implementation to use.
Definition: TBranch.h:157
Int_t FillEntryBuffer(TBasket *basket, TBuffer *buf, Int_t &lnew)
Copy the data from fEntryBuffer into the current basket.
Definition: TBranch.cxx:912
TBranch * GetSubBranch(const TBranch *br) const
Find the parent branch of child.
Definition: TBranch.cxx:1976
const Int_t kMapObject
Definition: TBranch.h:61
#define BIT(n)
Definition: Rtypes.h:83
virtual void DropBaskets(Option_t *option="")
Loop on all branch baskets.
Definition: TBranch.cxx:734
A cache to speed-up the reading of ROOT datasets.
Definition: TTreeCache.h:35
virtual void SetStatus(Bool_t status=1)
Set branch status to Process or DoNotProcess.
Definition: TBranch.cxx:2760
void ReadLeaves2Impl(TBuffer &b)
Read two leaves without the overhead of a loop.
Definition: TBranch.cxx:2300
virtual void SetFirstEntry(Long64_t entry)
set the first entry number (case of TBranchSTL)
Definition: TBranch.cxx:3088
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:48
virtual TLeaf * FindLeaf(const char *name)
Find the leaf corresponding to the name &#39;searchname&#39;.
Definition: TBranch.cxx:1057
Buffer base class used for serializing objects.
Definition: TBuffer.h:42
Bool_t IsFolder() const
Return kTRUE if more than one leaf or browsables, kFALSE otherwise.
Definition: TBranch.cxx:2084
TBasket * fCurrentBasket
! Pointer to the current basket.
Definition: TBranch.h:129
const Int_t kBranchObject
Definition: TBranch.h:59
TDirectory * GetDirectory() const
Definition: TBranch.h:218
#define N
Int_t GetOffset() const
Definition: TBranch.h:228
Int_t GetBulkEntries(Long64_t, TBuffer &)
Read as many events as possible into the given buffer, using zero-copy mechanisms.
Definition: TBranch.cxx:1425
TObjArray fBaskets
-> List of baskets of this branch
Definition: TBranch.h:136
Basic string class.
Definition: TString.h:131
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
TBasket * GetFreshCluster()
Drops the cluster two behind the current cluster and returns a fresh basket by either reusing or crea...
Definition: TBranch.cxx:1818
Int_t fNleaves
! Number of leaves
Definition: TBranch.h:124
Int_t GetCompressionAlgorithm() const
Definition: TBranch.h:292
TIOFeatures provides the end-user with the ability to change the IO behavior of data written via a TT...
Definition: TIOFeatures.hxx:62
TString GetRealFileName() const
Get real file name.
Definition: TBranch.cxx:1896
TObjArray fLeaves
-> List of leaves of this branch
Definition: TBranch.h:135
Long64_t * fBasketSeek
[fMaxBaskets] Addresses of baskets on file
Definition: TBranch.h:139
virtual void DeleteBaskets(Option_t *option="")
Loop on all branch baskets.
Definition: TBranch.cxx:703
Int_t GetEntryOffsetLen() const
Definition: TBranch.h:221
virtual Int_t GetRow(Int_t row)
Return all elements of one row unpacked in internal array fValues [Actually just returns 1 (...
Definition: TBranch.cxx:1936
void SetSkipZip(Bool_t skip=kTRUE)
Definition: TBranch.h:166
void SetCompressionSettings(Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseGeneralPurpose)
Set compression settings.
Definition: TBranch.cxx:2618
virtual void SetupAddresses()
If the branch address is not set, we set all addresses starting with the top level parent branch...
Definition: TBranch.cxx:3103
Long64_t fFirstBasketEntry
! First entry in the current basket.
Definition: TBranch.h:127
Int_t * fBasketBytes
[fMaxBaskets] Length of baskets on file
Definition: TBranch.h:137
virtual TList * GetBrowsables()
Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListO...
Definition: TBranch.cxx:1288
Long64_t fEntryNumber
Current entry number (last one filled in this branch)
Definition: TBranch.h:117
virtual void SetTree(TTree *tree)
Definition: TBranch.h:280
const Int_t kBranchAny
Definition: TBranch.h:60
Use the global compression algorithm.
Definition: Compression.h:83
TBasket * GetFreshBasket(TBuffer *user_buffer)
Return a fresh basket by either resusing an existing basket that needs to be drop (according to TTree...
Definition: TBranch.cxx:1764
Long64_t GetTotBytes(Option_t *option="") const
Return total number of bytes in the branch (excluding current buffer) if option ="*" includes all sub...
Definition: TBranch.cxx:2033
Int_t fWriteBasket
Last basket number written.
Definition: TBranch.h:116
Long64_t fTotBytes
Total number of bytes in all leaves before compression.
Definition: TBranch.h:132
Fill Area Attributes class.
Definition: TAttFill.h:19
Int_t * GetBasketBytes() const
Definition: TBranch.h:208
Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf)
Definition: TBranch.h:313
#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 void Browse(TBrowser *b)
Browser interface.
Definition: TBranch.cxx:676
virtual TLeaf * GetLeaf(const char *name) const
Return pointer to the 1st Leaf named name in thisBranch.
Definition: TBranch.cxx:1883
void ReadLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition: TBranch.cxx:2274
virtual Bool_t SetMakeClass(Bool_t decomposeObj=kTRUE)
Set the branch in a mode where the object are decomposed (Also known as MakeClass mode)...
Definition: TBranch.cxx:2740
virtual TBranch * FindBranch(const char *name)
Find the immediate sub-branch with passed name.
Definition: TBranch.cxx:1011
Int_t GetEntriesSerialized(Long64_t N, TBuffer &user_buf)
Definition: TBranch.h:179
Bool_t IsAutoDelete() const
Return kTRUE if an existing object in a TBranchObject must be deleted.
Definition: TBranch.cxx:2076
const Int_t kDoNotProcess
Definition: TBranch.h:57
TObjArray * GetListOfBranches()
Definition: TBranch.h:239
Int_t fMaxBaskets
Maximum number of Baskets so far.
Definition: TBranch.h:121
Long64_t GetEntryNumber() const
Definition: TBranch.h:235
ROOT::Experimental::Internal::TBulkBranchRead & GetBulkRead()
Definition: TBranch.h:212
Int_t fSplitLevel
Branch split level.
Definition: TBranch.h:123
TBranch & operator=(const TBranch &)=delete
TBranch()
Default constructor. Used for I/O by default.
Definition: TBranch.cxx:84
A doubly linked list.
Definition: TList.h:44
virtual void ResetAfterMerge(TFileMergeInfo *)
Reset a Branch.
Definition: TBranch.cxx:2411
Int_t Fill()
Definition: TBranch.h:199
const char * GetIconName() const
Return icon name depending on type of branch.
Definition: TBranch.cxx:1308
void PrintCacheInfo() const
Print the information we have about which basket is currently cached and whether they have been &#39;used...
Definition: TBranch.cxx:2258
Int_t GetEvent(Long64_t entry=0)
Definition: TBranch.h:222
Int_t GetCompressionSettings() const
Definition: TBranch.h:304
Using a TBrowser one can browse all ROOT objects.
Definition: TBrowser.h:37
void(TBranch::* ReadLeaves_t)(TBuffer &b)
Definition: TBranch.h:156
virtual void AddLastBasket(Long64_t startEntry)
Add the start entry of the write basket (not yet created)
Definition: TBranch.cxx:599
Int_t WriteBasket(TBasket *basket, Int_t where)
Definition: TBranch.h:171
TBuffer * fEntryBuffer
! Buffer used to directly pass the content without streaming
Definition: TBranch.h:146
Int_t GetReadBasket() const
Definition: TBranch.h:229
static Int_t fgCount
! branch counter
Definition: TBranch.h:112
void FillLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to fill Basket buffer.
Definition: TBranch.cxx:2309
virtual Int_t GetEntryExport(Long64_t entry, Int_t getall, TClonesArray *list, Int_t n)
Read all leaves of an entry and export buffers to real objects in a TClonesArray list.
Definition: TBranch.cxx:1635
virtual void SetOffset(Int_t offset=0)
Definition: TBranch.h:278
Int_t fBasketSize
Initial Size of Basket Buffer.
Definition: TBranch.h:114
CacheInfo_t fCacheInfo
! Hold info about which basket are in the cache and if they have been retrieved from the cache...
Definition: TBranch.h:154
virtual void SetEntries(Long64_t entries)
Set the number of entries in this branch.
Definition: TBranch.cxx:2651
TList * fBrowsables
! List of TVirtualBranchBrowsables used for Browse()
Definition: TBranch.h:148
void SetCompressionLevel(Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
Set compression level.
Definition: TBranch.cxx:2596
Some objects use this value to denote that the compression algorithm should be inherited from the par...
Definition: Compression.h:81
Long64_t GetFirstEntry() const
Definition: TBranch.h:236
Int_t GetWriteBasket() const
Definition: TBranch.h:231
const Int_t kIsClone
Definition: TBranch.h:58
FillLeaves_t fFillLeaves
! Pointer to the FillLeaves implementation to use.
Definition: TBranch.h:159
unsigned int UInt_t
Definition: RtypesCore.h:42
Long64_t fNextBasketEntry
! Next entry that will requires us to go to the next basket
Definition: TBranch.h:128
Manages buffers for branches of a Tree.
Definition: TBasket.h:34
Int_t GetMaxBaskets() const
Definition: TBranch.h:241
void SetCompressionAlgorithm(Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
Set compression algorithm.
Definition: TBranch.cxx:2576
virtual Int_t GetEntry(Long64_t entry=0, Int_t getall=0)
Read all leaves of entry and return total number of bytes read.
Definition: TBranch.cxx:1579
TBasket * fExtraBasket
! Allocated basket not currently holding any data.
Definition: TBranch.h:118
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:75
BulkObj fBulk
! Helper for performing bulk IO
Definition: TBranch.h:149
const char * GetFileName() const
Definition: TBranch.h:227
TBuffer * GetTransientBuffer(Int_t size)
Returns the transient buffer currently used by this TBranch for reading/writing baskets.
Definition: TBranch.cxx:511
void SetIOFeatures(TIOFeatures &features)
Definition: TBranch.h:276
virtual void KeepCircular(Long64_t maxEntries)
keep a maximum of fMaxEntries in memory
Definition: TBranch.cxx:2096
virtual Long64_t GetBasketSeek(Int_t basket) const
Return address of basket in the file.
Definition: TBranch.cxx:1278
const Bool_t kFALSE
Definition: RtypesCore.h:88
virtual void SetBasketSize(Int_t buffsize)
Set the basket size The function makes sure that the basket size is greater than fEntryOffsetlen.
Definition: TBranch.cxx:2542
Int_t GetEntriesSerialized(Long64_t evt, TBuffer &user_buf)
Definition: TBranch.h:314
ROOT::TIOFeatures TIOFeatures
Definition: TBranch.h:91
Bool_t fSkipZip
! After being read, the buffer will not be unzipped.
Definition: TBranch.h:151
Int_t fReadBasket
! Current basket number when reading
Definition: TBranch.h:125
virtual void ResetAddress()
Reset the address of the branch.
Definition: TBranch.cxx:2464
Describe directory structure in memory.
Definition: TDirectory.h:34
EStatusBits
Definition: TObject.h:57
Int_t WriteBasketImpl(TBasket *basket, Int_t where, ROOT::Internal::TBranchIMTHelper *)
Write the current basket to disk and return the number of bytes written to the file.
Definition: TBranch.cxx:3012
int type
Definition: TGX11.cxx:120
TIOFeatures GetIOFeatures() const
Returns the IO settings currently in use for this branch.
Definition: TBranch.cxx:2068
EDataType
Definition: TDataType.h:28
TTree * fTree
! Pointer to Tree header
Definition: TBranch.h:140
TObjArray * GetListOfLeaves()
Definition: TBranch.h:240
TDirectory * fDirectory
! Pointer to directory where this branch buffers are stored
Definition: TBranch.h:144
Int_t BackFill()
Loop on all leaves of this branch to back fill Basket buffer.
Definition: TBranch.cxx:657
TBasket * GetBasket(Int_t basket)
Definition: TBranch.h:207
Long64_t GetTotalSize(Option_t *option="") const
Return total number of bytes in the branch (including current buffer)
Definition: TBranch.cxx:2014
virtual void SetEntryOffsetLen(Int_t len, Bool_t updateSubBranches=kFALSE)
Update the default value for the branch&#39;s fEntryOffsetLen if and only if it was already non zero (and...
Definition: TBranch.cxx:2634
typedef void((*Func_t)())
virtual void SetFile(TFile *file=0)
Set file where this branch writes/reads its buffers.
Definition: TBranch.cxx:2676
virtual void Refresh(TBranch *b)
Refresh this branch using new information in b This function is called by TTree::Refresh.
Definition: TBranch.cxx:2321
Long64_t GetEntries() const
Definition: TBranch.h:244
An array of clone (identical) objects.
Definition: TClonesArray.h:32
void ReadLeaves0Impl(TBuffer &b)
Read zero leaves without the overhead of a loop.
Definition: TBranch.cxx:2285
Class implementing or helping the various TTree cloning method.
Definition: TTreeCloner.h:38
Long64_t * fBasketEntry
[fMaxBaskets] Table of first entry in each basket
Definition: TBranch.h:138
Definition: file.py:1
virtual void Reset(Option_t *option="")
Reset a Branch.
Definition: TBranch.cxx:2370
TIOFeatures fIOFeatures
IO features for newly-created baskets.
Definition: TBranch.h:119
void(TBranch::* FillLeaves_t)(TBuffer &b)
Definition: TBranch.h:158
Long64_t fReadEntry
! Current entry number when reading
Definition: TBranch.h:126
Long64_t GetReadEntry() const
Definition: TBranch.h:230
you should not use this method at all Int_t Int_t Double_t Double_t Double_t Int_t Double_t Double_t Double_t Double_t b
Definition: TRolke.cxx:630
virtual void AddBasket(TBasket &b, Bool_t ondisk, Long64_t startEntry)
Add the basket to this branch.
Definition: TBranch.cxx:533
TBranch * fMother
! Pointer to top-level parent branch in the tree.
Definition: TBranch.h:141
virtual Int_t LoadBaskets()
Baskets associated to this branch are forced to be in memory.
Definition: TBranch.cxx:2122
virtual Bool_t GetMakeClass() const
Return whether this branch is in a mode where the object are decomposed or not (Also known as MakeCla...
Definition: TBranch.cxx:1945
TTree * GetTree() const
Definition: TBranch.h:245
Int_t GetBasketAndFirst(TBasket *&basket, Long64_t &first, TBuffer *user_buffer)
A helper function to locate the correct basket - and its first entry.
Definition: TBranch.cxx:1325
Use the recommended general-purpose setting; moderate read / write speed and compression ratio...
Definition: Compression.h:54
Definition: tree.py:1
virtual char * GetAddress() const
Definition: TBranch.h:206
A TTree represents a columnar dataset.
Definition: TTree.h:72
Int_t fEntryOffsetLen
Initial Length of fEntryOffset table in the basket buffers.
Definition: TBranch.h:115
virtual void ReadBasket(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition: TBranch.cxx:2266
Definition: first.py:1
Int_t FlushBaskets()
Flush to disk all the baskets of this branch and any of subbranches.
Definition: TBranch.cxx:1112
TObjArray fBranches
-> List of Branches of this branch
Definition: TBranch.h:134
virtual void ResetReadEntry()
Definition: TBranch.h:262
virtual TFile * GetFile(Int_t mode=0)
Return pointer to the file where branch buffers reside, returns 0 in case branch buffers reside in th...
Definition: TBranch.cxx:1726
A TTree is a list of TBranches.
Definition: TBranch.h:90
TBuffer * fTransientBuffer
! Pointer to the current transient buffer.
Definition: TBranch.h:147
Int_t fCompress
Compression level and algorithm.
Definition: TBranch.h:113
virtual void Print(Option_t *option="") const
Print TBranch parameters.
Definition: TBranch.cxx:2154
Helper class for reading many branch entries at once to optimize throughput.
Definition: TBranch.h:69
TBasket * GetBasketImpl(Int_t basket, TBuffer *user_buffer)
Return pointer to basket basketnumber in this Branch.
Definition: TBranch.cxx:1202
TString fFileName
Name of file where buffers are stored ("" if in same file as Tree header)
Definition: TBranch.h:145
const Bool_t kTRUE
Definition: RtypesCore.h:87
TBranch * fParent
! Pointer to parent branch.
Definition: TBranch.h:142
const Int_t n
Definition: legend1.C:16
Long64_t fFirstEntry
Number of the first entry in this branch.
Definition: TBranch.h:131
TBranch * GetMother() const
Get our top-level parent branch in the tree.
Definition: TBranch.cxx:1955
char name[80]
Definition: TGX11.cxx:109
void ExpandBasketArrays()
Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size...
Definition: TBranch.cxx:802
virtual void SetObject(void *objadd)
Set object this branch is pointing to.
Definition: TBranch.cxx:2749
void ReadLeaves1Impl(TBuffer &b)
Read one leaf without the overhead of a loop.
Definition: TBranch.cxx:2292
static void ResetCount()
Static function resetting fgCount.
Definition: TBranch.cxx:2487
Int_t GetNleaves() const
Definition: TBranch.h:242
const char * Data() const
Definition: TString.h:364
virtual void SetAutoDelete(Bool_t autodel=kTRUE)
Set the automatic delete bit.
Definition: TBranch.cxx:2529
char * fAddress
! Address of 1st leaf (variable or object)
Definition: TBranch.h:143