Logo ROOT  
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 "TNamed.h"
27#include "TAttFill.h"
28#include "TObjArray.h"
29#include "TBranchCacheInfo.h"
30#include "TDataType.h"
31#include "Compression.h"
32#include "ROOT/TIOFeatures.hxx"
33
34class TTree;
35class TBasket;
36class TBranchElement;
37class TLeaf;
38class TBrowser;
39class TDirectory;
40class TFile;
41class TClonesArray;
42class TTreeCloner;
43class TTreeCache;
44
45namespace ROOT {
46namespace Experimental {
47namespace Internal {
48class TBulkBranchRead;
49}
50}
51namespace Internal {
52class TBranchIMTHelper; ///< A helper class for managing IMT work during TTree:Fill operations.
53}
54}
55
56const Int_t kDoNotProcess = BIT(10); // Active bit for branches
57const Int_t kIsClone = BIT(11); // to indicate a TBranchClones
58const Int_t kBranchObject = BIT(12); // branch is a TObject*
59const Int_t kBranchAny = BIT(17); // branch is an object*
61
62namespace ROOT {
63namespace Experimental {
64namespace Internal {
65
66///\class TBulkBranchRead
67/// Helper class for reading many branch entries at once to optimize throughput.
69
70 friend class ::TBranch;
71
72public:
73 Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf);
75 Int_t GetEntriesSerialized(Long64_t evt, TBuffer &user_buf, TBuffer *count_buf);
77
78private:
80 : fParent(parent)
81 {}
82
84};
85}
86}
87}
88
89class TBranch : public TNamed , public TAttFill {
91
92protected:
93 friend class TTreeCache;
94 friend class TTreeCloner;
95 friend class TTree;
96 friend class TBranchElement;
98
99 /// TBranch status bits
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);
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(Int_t basketnumber, TBuffer *user_buffer);
171 Int_t WriteBasket(TBasket* basket, Int_t where) { return WriteBasketImpl(basket, where, nullptr); }
172
173 TString GetRealFileName() const;
174
175 virtual void SetAddressImpl(void *addr, Bool_t /* implied */) { SetAddress(addr); }
176
177private:
178 Int_t GetBasketAndFirst(TBasket*& basket, Long64_t& first, TBuffer* user_buffer);
179 TBasket *GetBasketImpl(Int_t basket, TBuffer* user_buffer);
181 Int_t GetEntriesSerialized(Long64_t N, TBuffer& user_buf) {return GetEntriesSerialized(N, user_buf, nullptr);}
183 Int_t FillEntryBuffer(TBasket* basket,TBuffer* buf, Int_t& lnew);
185 TBranch(const TBranch&) = delete; // not implemented
186 TBranch& operator=(const TBranch&) = delete; // not implemented
187
188public:
189 TBranch();
190 TBranch(TTree *tree, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
191 TBranch(TBranch *parent, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
192 virtual ~TBranch();
193
194 virtual void AddBasket(TBasket &b, Bool_t ondisk, Long64_t startEntry);
195 virtual void AddLastBasket(Long64_t startEntry);
196 Int_t BackFill();
197 virtual void Browse(TBrowser *b);
198 virtual void DeleteBaskets(Option_t* option="");
199 virtual void DropBaskets(Option_t *option = "");
200 void ExpandBasketArrays();
201 Int_t Fill() { return FillImpl(nullptr); }
203 virtual TBranch *FindBranch(const char *name);
204 virtual TLeaf *FindLeaf(const char *name);
207
208 virtual char *GetAddress() const {return fAddress;}
209 TBasket *GetBasket(Int_t basket) {return GetBasketImpl(basket, nullptr);}
212 virtual Long64_t GetBasketSeek(Int_t basket) const;
213 virtual Int_t GetBasketSize() const {return fBasketSize;}
215 virtual TList *GetBrowsables();
216 virtual const char* GetClassName() const;
221 virtual Int_t GetEntry(Long64_t entry=0, Int_t getall = 0);
222 virtual Int_t GetEntryExport(Long64_t entry, Int_t getall, TClonesArray *list, Int_t n);
224 Int_t GetEvent(Long64_t entry=0) {return GetEntry(entry);}
225 virtual TString GetFullName() const;
226 const char *GetIconName() const;
227 virtual Int_t GetExpectedType(TClass *&clptr,EDataType &type);
228 virtual TLeaf *GetLeaf(const char *name) const;
229 virtual TFile *GetFile(Int_t mode=0);
230 const char *GetFileName() const {return fFileName.Data();}
231 Int_t GetOffset() const {return fOffset;}
235 Long64_t GetTotalSize(Option_t *option="") const;
236 Long64_t GetTotBytes(Option_t *option="") const;
237 Long64_t GetZipBytes(Option_t *option="") const;
245 Int_t GetNleaves() const {return fNleaves;}
247 Long64_t GetEntries() const {return fEntries;}
248 TTree *GetTree() const {return fTree;}
249 virtual Int_t GetRow(Int_t row);
250 virtual Bool_t GetMakeClass() const;
251 TBranch *GetMother() const;
252 TBranch *GetSubBranch(const TBranch *br) const;
254 Bool_t IsAutoDelete() const;
255 Bool_t IsFolder() const;
256 virtual void KeepCircular(Long64_t maxEntries);
257 virtual Int_t LoadBaskets();
258 virtual void Print(Option_t *option="") const;
259 void PrintCacheInfo() const;
260 virtual void ReadBasket(TBuffer &b);
261 virtual void Refresh(TBranch *b);
262 virtual void Reset(Option_t *option="");
263 virtual void ResetAfterMerge(TFileMergeInfo *);
264 virtual void ResetAddress();
265 virtual void ResetReadEntry() {fReadEntry = -1;}
266 virtual void SetAddress(void *add);
267 virtual void SetObject(void *objadd);
268 virtual void SetAutoDelete(Bool_t autodel=kTRUE);
269 virtual void SetBasketSize(Int_t buffsize);
270 virtual void SetBufferAddress(TBuffer *entryBuffer);
274 virtual void SetEntries(Long64_t entries);
275 virtual void SetEntryOffsetLen(Int_t len, Bool_t updateSubBranches = kFALSE);
276 virtual void SetFirstEntry( Long64_t entry );
277 virtual void SetFile(TFile *file=0);
278 virtual void SetFile(const char *filename);
279 void SetIOFeatures(TIOFeatures &features) {fIOFeatures = features;}
280 virtual Bool_t SetMakeClass(Bool_t decomposeObj = kTRUE);
281 virtual void SetOffset(Int_t offset=0) {fOffset=offset;}
282 virtual void SetStatus(Bool_t status=1);
283 virtual void SetTree(TTree *tree) { fTree = tree;}
284 virtual void SetupAddresses();
285 Bool_t SupportsBulkRead() const;
286 virtual void UpdateAddress() {;}
287 virtual void UpdateFile();
288
289 static void ResetCount();
290
291 ClassDef(TBranch, 13); // Branch descriptor
292};
293
294//______________________________________________________________________________
296{
297 return (fCompress < 0) ? -1 : fCompress / 100;
298}
299
300//______________________________________________________________________________
302{
303 return (fCompress < 0) ? -1 : fCompress % 100;
304}
305
306//______________________________________________________________________________
308{
309 return (fCompress < 0) ? -1 : fCompress;
310}
311
312namespace ROOT {
313namespace Experimental {
314namespace Internal {
315
316inline Int_t TBulkBranchRead::GetBulkEntries(Long64_t evt, TBuffer& user_buf) { return fParent.GetBulkEntries(evt, user_buf); }
318inline Int_t TBulkBranchRead::GetEntriesSerialized(Long64_t evt, TBuffer& user_buf, TBuffer* count_buf) { return fParent.GetEntriesSerialized(evt, user_buf, count_buf); }
320
321} // Internal
322} // Experimental
323} // ROOT
324
325#endif
typedef void(GLAPIENTRYP _GLUfuncptr)(void)
#define b(i)
Definition: RSha256.hxx:100
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
int Int_t
Definition: RtypesCore.h:45
unsigned int UInt_t
Definition: RtypesCore.h:46
const Bool_t kFALSE
Definition: RtypesCore.h:101
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
#define BIT(n)
Definition: Rtypes.h:85
const Int_t kBranchAny
Definition: TBranch.h:59
const Int_t kMapObject
Definition: TBranch.h:60
const Int_t kBranchObject
Definition: TBranch.h:58
const Int_t kDoNotProcess
Definition: TBranch.h:56
const Int_t kIsClone
Definition: TBranch.h:57
EDataType
Definition: TDataType.h:28
#define N
char name[80]
Definition: TGX11.cxx:110
int type
Definition: TGX11.cxx:121
Helper class for reading many branch entries at once to optimize throughput.
Definition: TBranch.h:68
Int_t GetEntriesSerialized(Long64_t evt, TBuffer &user_buf)
Definition: TBranch.h:317
Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf)
Definition: TBranch.h:316
A helper class for managing IMT work during TTree:Fill operations.
TIOFeatures provides the end-user with the ability to change the IO behavior of data written via a TT...
Definition: TIOFeatures.hxx:69
Fill Area Attributes class.
Definition: TAttFill.h:19
Manages buffers for branches of a Tree.
Definition: TBasket.h:34
A Branch for the case of an object.
A TTree is a list of TBranches.
Definition: TBranch.h:89
virtual TLeaf * GetLeaf(const char *name) const
Return pointer to the 1st Leaf named name in thisBranch.
Definition: TBranch.cxx:1972
void SetSkipZip(Bool_t skip=kTRUE)
Definition: TBranch.h:166
virtual void SetupAddresses()
If the branch address is not set, we set all addresses starting with the top level parent branch.
Definition: TBranch.cxx:3211
virtual void ResetAddress()
Reset the address of the branch.
Definition: TBranch.cxx:2568
virtual void SetAutoDelete(Bool_t autodel=kTRUE)
Set the automatic delete bit.
Definition: TBranch.cxx:2633
TString fFileName
Name of file where buffers are stored ("" if in same file as Tree header)
Definition: TBranch.h:145
virtual const char * GetClassName() const
Return the name of the user class whose content is stored in this branch, if any.
Definition: TBranch.cxx:1322
const char * GetIconName() const
Return icon name depending on type of branch.
Definition: TBranch.cxx:1330
TBasket * GetFreshBasket(Int_t basketnumber, TBuffer *user_buffer)
Return a fresh basket by either reusing an existing basket that needs to be drop (according to TTree:...
Definition: TBranch.cxx:1832
TBasket * GetBasketImpl(Int_t basket, TBuffer *user_buffer)
Return pointer to basket basketnumber in this Branch.
Definition: TBranch.cxx:1224
Int_t fEntryOffsetLen
Initial Length of fEntryOffset table in the basket buffers.
Definition: TBranch.h:115
virtual void DeleteBaskets(Option_t *option="")
Loop on all branch baskets.
Definition: TBranch.cxx:724
virtual Long64_t GetBasketSeek(Int_t basket) const
Return address of basket in the file.
Definition: TBranch.cxx:1300
TBranch()
Default constructor. Used for I/O by default.
Definition: TBranch.cxx:87
virtual char * GetAddress() const
Definition: TBranch.h:208
void SetCompressionSettings(Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
Set compression settings.
Definition: TBranch.cxx:2722
Int_t BackFill()
Loop on all leaves of this branch to back fill Basket buffer.
Definition: TBranch.cxx:678
Int_t GetCompressionSettings() const
Definition: TBranch.h:307
Int_t GetCompressionLevel() const
Definition: TBranch.h:301
Int_t GetCompressionAlgorithm() const
Definition: TBranch.h:295
Int_t fMaxBaskets
Maximum number of Baskets so far.
Definition: TBranch.h:121
Long64_t fTotBytes
Total number of bytes in all leaves before compression.
Definition: TBranch.h:132
TBuffer * fTransientBuffer
! Pointer to the current transient buffer.
Definition: TBranch.h:147
virtual void ReadBasket(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition: TBranch.cxx:2370
TTree * GetTree() const
Definition: TBranch.h:248
FillLeaves_t fFillLeaves
! Pointer to the FillLeaves implementation to use.
Definition: TBranch.h:159
virtual TString GetFullName() const
Return the 'full' name of the branch.
Definition: TBranch.cxx:1956
Int_t GetWriteBasket() const
Definition: TBranch.h:234
void(TBranch::* ReadLeaves_t)(TBuffer &b)
Definition: TBranch.h:156
@ kAutoDelete
Definition: TBranch.h:106
@ kDoNotUseBufferMap
If set, at least one of the entry in the branch will use the buffer's map of classname and objects.
Definition: TBranch.h:108
@ kBranchAny
Branch is an object*.
Definition: TBranch.h:104
@ kIsClone
To indicate a TBranchClones.
Definition: TBranch.h:102
@ kBranchObject
Branch is a TObject*.
Definition: TBranch.h:103
@ kDoNotProcess
Active bit for branches.
Definition: TBranch.h:101
TObjArray fLeaves
-> List of leaves of this branch
Definition: TBranch.h:135
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:1351
char * fAddress
! Address of 1st leaf (variable or object)
Definition: TBranch.h:143
virtual void DropBaskets(Option_t *option="")
Loop on all branch baskets.
Definition: TBranch.cxx:755
TObjArray * GetListOfBranches()
Definition: TBranch.h:242
virtual TList * GetBrowsables()
Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListO...
Definition: TBranch.cxx:1310
TList * fBrowsables
! List of TVirtualBranchBrowsables used for Browse()
Definition: TBranch.h:148
void ReadLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition: TBranch.cxx:2378
virtual void SetTree(TTree *tree)
Definition: TBranch.h:283
Int_t fOffset
Offset of this branch.
Definition: TBranch.h:120
Long64_t * fBasketEntry
[fMaxBaskets] Table of first entry in each basket
Definition: TBranch.h:138
Int_t GetEntriesSerialized(Long64_t N, TBuffer &user_buf)
Definition: TBranch.h:181
ROOT::Experimental::Internal::TBulkBranchRead & GetBulkRead()
Definition: TBranch.h:214
virtual void SetEntryOffsetLen(Int_t len, Bool_t updateSubBranches=kFALSE)
Update the default value for the branch's fEntryOffsetLen if and only if it was already non zero (and...
Definition: TBranch.cxx:2738
void ExpandBasketArrays()
Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size...
Definition: TBranch.cxx:823
Int_t GetSplitLevel() const
Definition: TBranch.h:246
ROOT::TIOFeatures TIOFeatures
Definition: TBranch.h:90
void Init(const char *name, const char *leaflist, Int_t compress)
Definition: TBranch.cxx:300
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:1644
const char * GetFileName() const
Definition: TBranch.h:230
TIOFeatures GetIOFeatures() const
Returns the IO settings currently in use for this branch.
Definition: TBranch.cxx:2172
void FillLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to fill Basket buffer.
Definition: TBranch.cxx:2413
Long64_t fReadEntry
! Current entry number when reading
Definition: TBranch.h:126
virtual void AddBasket(TBasket &b, Bool_t ondisk, Long64_t startEntry)
Add the basket to this branch.
Definition: TBranch.cxx:543
static void ResetCount()
Static function resetting fgCount.
Definition: TBranch.cxx:2591
virtual void SetAddressImpl(void *addr, Bool_t)
Definition: TBranch.h:175
TBranch * GetSubBranch(const TBranch *br) const
Find the parent branch of child.
Definition: TBranch.cxx:2081
ReadLeaves_t fReadLeaves
! Pointer to the ReadLeaves implementation to use.
Definition: TBranch.h:157
virtual void SetObject(void *objadd)
Set object this branch is pointing to.
Definition: TBranch.cxx:2853
Int_t FlushBaskets()
Flush to disk all the baskets of this branch and any of subbranches.
Definition: TBranch.cxx:1134
void ReadLeaves2Impl(TBuffer &b)
Read two leaves without the overhead of a loop.
Definition: TBranch.cxx:2404
TBasket * GetFreshCluster()
Drops the cluster two behind the current cluster and returns a fresh basket by either reusing or crea...
Definition: TBranch.cxx:1891
virtual void SetAddress(void *add)
Set address of this branch.
Definition: TBranch.cxx:2599
static Int_t fgCount
! branch counter
Definition: TBranch.h:112
void(TBranch::* FillLeaves_t)(TBuffer &b)
Definition: TBranch.h:158
Int_t GetEvent(Long64_t entry=0)
Definition: TBranch.h:224
virtual void AddLastBasket(Long64_t startEntry)
Add the start entry of the write basket (not yet created)
Definition: TBranch.cxx:616
TBasket * GetBasket(Int_t basket)
Definition: TBranch.h:209
Int_t fNBaskets
! Number of baskets in memory
Definition: TBranch.h:122
void ReadLeaves1Impl(TBuffer &b)
Read one leaf without the overhead of a loop.
Definition: TBranch.cxx:2396
Int_t GetNleaves() const
Definition: TBranch.h:245
Int_t GetBulkEntries(Long64_t, TBuffer &)
Read as many events as possible into the given buffer, using zero-copy mechanisms.
Definition: TBranch.cxx:1454
Bool_t IsFolder() const
Return kTRUE if more than one leaf or browsables, kFALSE otherwise.
Definition: TBranch.cxx:2188
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:1700
Long64_t fZipBytes
Total number of bytes in all leaves after compression.
Definition: TBranch.h:133
TIOFeatures fIOFeatures
IO features for newly-created baskets.
Definition: TBranch.h:119
void SetCompressionAlgorithm(Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
Set compression algorithm.
Definition: TBranch.cxx:2680
virtual void UpdateAddress()
Definition: TBranch.h:286
Bool_t IsAutoDelete() const
Return kTRUE if an existing object in a TBranchObject must be deleted.
Definition: TBranch.cxx:2180
Int_t GetOffset() const
Definition: TBranch.h:231
virtual TLeaf * FindLeaf(const char *name)
Find the leaf corresponding to the name 'searchname'.
Definition: TBranch.cxx:1079
BulkObj fBulk
! Helper for performing bulk IO
Definition: TBranch.h:149
Long64_t GetReadEntry() const
Definition: TBranch.h:233
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
TObjArray * GetListOfBaskets()
Definition: TBranch.h:241
virtual void SetBufferAddress(TBuffer *entryBuffer)
Set address of this branch directly from a TBuffer to avoid streaming.
Definition: TBranch.cxx:2662
Long64_t GetEntries() const
Definition: TBranch.h:247
Int_t fNleaves
! Number of leaves
Definition: TBranch.h:124
Int_t fSplitLevel
Branch split level.
Definition: TBranch.h:123
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:3119
virtual void UpdateFile()
Refresh the value of fDirectory (i.e.
Definition: TBranch.cxx:3221
Int_t GetReadBasket() const
Definition: TBranch.h:232
Int_t * fBasketBytes
[fMaxBaskets] Length of baskets on file
Definition: TBranch.h:137
virtual void Print(Option_t *option="") const
Print TBranch parameters.
Definition: TBranch.cxx:2258
Long64_t fNextBasketEntry
! Next entry that will requires us to go to the next basket
Definition: TBranch.h:128
Int_t GetMaxBaskets() const
Definition: TBranch.h:244
Int_t * GetBasketBytes() const
Definition: TBranch.h:210
TBranch & operator=(const TBranch &)=delete
virtual ~TBranch()
Destructor.
Definition: TBranch.cxx:450
Int_t FillEntryBuffer(TBasket *basket, TBuffer *buf, Int_t &lnew)
Copy the data from fEntryBuffer into the current basket.
Definition: TBranch.cxx:933
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:1791
virtual void Browse(TBrowser *b)
Browser interface.
Definition: TBranch.cxx:697
TObjArray fBranches
-> List of Branches of this branch
Definition: TBranch.h:134
virtual void KeepCircular(Long64_t maxEntries)
keep a maximum of fMaxEntries in memory
Definition: TBranch.cxx:2200
virtual void ResetAfterMerge(TFileMergeInfo *)
Reset a Branch.
Definition: TBranch.cxx:2515
void ReadLeaves0Impl(TBuffer &b)
Read zero leaves without the overhead of a loop.
Definition: TBranch.cxx:2389
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:2034
virtual void ResetReadEntry()
Definition: TBranch.h:265
TString GetRealFileName() const
Get real file name.
Definition: TBranch.cxx:1985
virtual TBranch * FindBranch(const char *name)
Find the immediate sub-branch with passed name.
Definition: TBranch.cxx:1033
TBranch(const TBranch &)=delete
TDirectory * fDirectory
! Pointer to directory where this branch buffers are stored
Definition: TBranch.h:144
void PrintCacheInfo() const
Print the information we have about which basket is currently cached and whether they have been 'used...
Definition: TBranch.cxx:2362
TObjArray fBaskets
-> List of baskets of this branch
Definition: TBranch.h:136
virtual Int_t LoadBaskets()
Baskets associated to this branch are forced to be in memory.
Definition: TBranch.cxx:2226
void SetIOFeatures(TIOFeatures &features)
Definition: TBranch.h:279
Bool_t fSkipZip
! After being read, the buffer will not be unzipped.
Definition: TBranch.h:151
TBranch * fMother
! Pointer to top-level parent branch in the tree.
Definition: TBranch.h:141
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:2137
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:2844
virtual void SetFile(TFile *file=0)
Set file where this branch writes/reads its buffers.
Definition: TBranch.cxx:2780
TBranch * fParent
! Pointer to parent branch.
Definition: TBranch.h:142
Int_t WriteBasket(TBasket *basket, Int_t where)
Definition: TBranch.h:171
virtual void SetOffset(Int_t offset=0)
Definition: TBranch.h:281
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:1180
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:1772
virtual Int_t GetBasketSize() const
Definition: TBranch.h:213
virtual void SetFirstEntry(Long64_t entry)
set the first entry number (case of TBranchSTL)
Definition: TBranch.cxx:3196
Long64_t GetTotalSize(Option_t *option="") const
Return total number of bytes in the branch (including current buffer)
Definition: TBranch.cxx:2118
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:2155
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:2646
virtual void Refresh(TBranch *b)
Refresh this branch using new information in b This function is called by TTree::Refresh.
Definition: TBranch.cxx:2425
Int_t fWriteBasket
Last basket number written.
Definition: TBranch.h:116
Long64_t * fBasketSeek
[fMaxBaskets] Addresses of baskets on file
Definition: TBranch.h:139
Long64_t GetEntryNumber() const
Definition: TBranch.h:238
virtual void SetStatus(Bool_t status=1)
Set branch status to Process or DoNotProcess.
Definition: TBranch.cxx:2864
TObjArray * GetListOfLeaves()
Definition: TBranch.h:243
virtual void SetEntries(Long64_t entries)
Set the number of entries in this branch.
Definition: TBranch.cxx:2755
Int_t fReadBasket
! Current basket number when reading
Definition: TBranch.h:125
TDirectory * GetDirectory() const
Definition: TBranch.h:220
Long64_t fFirstEntry
Number of the first entry in this branch.
Definition: TBranch.h:131
TBasket * fExtraBasket
! Allocated basket not currently holding any data.
Definition: TBranch.h:118
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:2025
Long64_t GetFirstEntry() const
Definition: TBranch.h:239
Int_t fBasketSize
Initial Size of Basket Buffer.
Definition: TBranch.h:114
Int_t Fill()
Definition: TBranch.h:201
virtual void Reset(Option_t *option="")
Reset a Branch.
Definition: TBranch.cxx:2474
Long64_t fEntryNumber
Current entry number (last one filled in this branch)
Definition: TBranch.h:117
TBranch * GetMother() const
Get our top-level parent branch in the tree.
Definition: TBranch.cxx:2044
Int_t fCompress
Compression level and algorithm.
Definition: TBranch.h:113
TBuffer * GetTransientBuffer(Int_t size)
Returns the transient buffer currently used by this TBranch for reading/writing baskets.
Definition: TBranch.cxx:521
virtual Int_t FillImpl(ROOT::Internal::TBranchIMTHelper *)
Loop on all leaves of this branch to fill Basket buffer.
Definition: TBranch.cxx:854
TBuffer * fEntryBuffer
! Buffer used to directly pass the content without streaming
Definition: TBranch.h:146
TBasket * fCurrentBasket
! Pointer to the current basket.
Definition: TBranch.h:129
Long64_t fFirstBasketEntry
! First entry in the current basket.
Definition: TBranch.h:127
void SetCompressionLevel(Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
Set compression level.
Definition: TBranch.cxx:2700
Long64_t * GetBasketEntry() const
Definition: TBranch.h:211
Int_t GetEntryOffsetLen() const
Definition: TBranch.h:223
Long64_t fEntries
Number of entries.
Definition: TBranch.h:130
Bool_t SupportsBulkRead() const
Returns true if this branch supports bulk IO, false otherwise.
Definition: TBranch.cxx:1429
TTree * fTree
! Pointer to Tree header
Definition: TBranch.h:140
Using a TBrowser one can browse all ROOT objects.
Definition: TBrowser.h:37
Buffer base class used for serializing objects.
Definition: TBuffer.h:43
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:80
An array of clone (identical) objects.
Definition: TClonesArray.h:29
Describe directory structure in memory.
Definition: TDirectory.h:45
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:54
A TLeaf describes individual elements of a TBranch See TBranch structure in TTree.
Definition: TLeaf.h:57
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
EStatusBits
Definition: TObject.h:57
Basic string class.
Definition: TString.h:136
const char * Data() const
Definition: TString.h:369
A cache to speed-up the reading of ROOT datasets.
Definition: TTreeCache.h:32
Class implementing or helping the various TTree cloning method.
Definition: TTreeCloner.h:31
A TTree represents a columnar dataset.
Definition: TTree.h:79
const Int_t n
Definition: legend1.C:16
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
Definition: file.py:1
Definition: first.py:1
Definition: tree.py:1
@ kUseGlobal
Use the global compression algorithm.
Definition: Compression.h:88
@ kInherit
Some objects use this value to denote that the compression algorithm should be inherited from the par...
Definition: Compression.h:86
@ kUseCompiledDefault
Use the compile-time default setting.
Definition: Compression.h:50
@ kUseMin
Compression level reserved when we are not sure what to use (1 is for the fastest compression)
Definition: Compression.h:68