Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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 /// See TBranch::GetBulkEntries(Long64_t evt, TBuffer &user_buf);
74 Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf);
75 /// See TBranch::GetEntriesSerialized(Long64_t evt, TBuffer &user_buf);
77 /// See TBranch::GetEntriesSerialized(Long64_t evt, TBuffer &user_buf, TBuffer *count_buf);
78 Int_t GetEntriesSerialized(Long64_t evt, TBuffer &user_buf, TBuffer *count_buf);
79 /// Return true if the branch can be read through the bulk interfaces.
80 bool SupportsBulkRead() const;
81
82private:
84 : fParent(parent)
85 {}
86
88};
89}
90}
91}
92
93class TBranch : public TNamed, public TAttFill {
95
96protected:
97 friend class TTreeCache;
98 friend class TTreeCloner;
99 friend class TTree;
100 friend class TBranchElement;
102
103 /// TBranch status bits
105 kDoNotProcess = ::kDoNotProcess, ///< Active bit for branches
106 kIsClone = ::kIsClone, ///< To indicate a TBranchClones
107 kBranchObject = ::kBranchObject, ///< Branch is a TObject*
108 kBranchAny = ::kBranchAny, ///< Branch is an object*
109 // kMapObject = kBranchObject | kBranchAny;
111
112 kDoNotUseBufferMap = BIT(22) ///< If set, at least one of the entry in the branch will use the buffer's map of classname and objects.
113 };
114
116 static Int_t fgCount; ///<! branch counter
117 Int_t fCompress; ///< Compression level and algorithm
118 Int_t fBasketSize; ///< Initial Size of Basket Buffer
119 Int_t fEntryOffsetLen; ///< Initial Length of fEntryOffset table in the basket buffers
120 Int_t fWriteBasket; ///< Last basket number written
121 Long64_t fEntryNumber; ///< Current entry number (last one filled in this branch)
122 TBasket *fExtraBasket; ///<! Allocated basket not currently holding any data.
123 TIOFeatures fIOFeatures; ///< IO features for newly-created baskets.
124 Int_t fOffset; ///< Offset of this branch
125 Int_t fMaxBaskets; ///< Maximum number of Baskets so far
126 Int_t fNBaskets; ///<! Number of baskets in memory
127 Int_t fSplitLevel; ///< Branch split level
128 Int_t fNleaves; ///<! Number of leaves
129 Int_t fReadBasket; ///<! Current basket number when reading
130 Long64_t fReadEntry; ///<! Current entry number when reading
131 Long64_t fFirstBasketEntry; ///<! First entry in the current basket.
132 Long64_t fNextBasketEntry; ///<! Next entry that will requires us to go to the next basket
133 TBasket *fCurrentBasket; ///<! Pointer to the current basket.
134 Long64_t fEntries; ///< Number of entries
135 Long64_t fFirstEntry; ///< Number of the first entry in this branch
136 Long64_t fTotBytes; ///< Total number of bytes in all leaves before compression
137 Long64_t fZipBytes; ///< Total number of bytes in all leaves after compression
138 TObjArray fBranches; ///< -> List of Branches of this branch
139 TObjArray fLeaves; ///< -> List of leaves of this branch
140 TObjArray fBaskets; ///< -> List of baskets of this branch
141 Int_t *fBasketBytes; ///<[fMaxBaskets] Length of baskets on file
142 Long64_t *fBasketEntry; ///<[fMaxBaskets] Table of first entry in each basket
143 Long64_t *fBasketSeek; ///<[fMaxBaskets] Addresses of baskets on file
144 TTree *fTree; ///<! Pointer to Tree header
145 TBranch *fMother; ///<! Pointer to top-level parent branch in the tree.
146 TBranch *fParent; ///<! Pointer to parent branch.
147 char *fAddress; ///<! Address of 1st leaf (variable or object)
148 TDirectory *fDirectory; ///<! Pointer to directory where this branch buffers are stored
149 TString fFileName; ///< Name of file where buffers are stored ("" if in same file as Tree header)
150 TBuffer *fEntryBuffer; ///<! Buffer used to directly pass the content without streaming
151 TBuffer *fTransientBuffer; ///<! Pointer to the current transient buffer.
152 TList *fBrowsables; ///<! List of TVirtualBranchBrowsables used for Browse()
153 BulkObj fBulk; ///<! Helper for performing bulk IO
154
155 bool fSkipZip; ///<! After being read, the buffer will not be unzipped.
156
158 CacheInfo_t fCacheInfo; ///<! Hold info about which basket are in the cache and if they have been retrieved from the cache.
159
160 typedef void (TBranch::*ReadLeaves_t)(TBuffer &b);
161 ReadLeaves_t fReadLeaves; ///<! Pointer to the ReadLeaves implementation to use.
162 typedef void (TBranch::*FillLeaves_t)(TBuffer &b);
163 FillLeaves_t fFillLeaves; ///<! Pointer to the FillLeaves implementation to use.
164 void ReadLeavesImpl(TBuffer &b);
168 void FillLeavesImpl(TBuffer &b);
169
170 void SetSkipZip(bool skip = true) { fSkipZip = skip; }
171 void Init(const char *name, const char *leaflist, Int_t compress);
172
173 TBasket *GetFreshBasket(Int_t basketnumber, TBuffer *user_buffer);
174 TBasket *GetFreshCluster(TBuffer *user_buffer);
175 Int_t WriteBasket(TBasket* basket, Int_t where) { return WriteBasketImpl(basket, where, nullptr); }
176
177 TString GetRealFileName() const;
178
179 virtual void SetAddressImpl(void *addr, bool /* implied */) { SetAddress(addr); }
180
181private:
182 Int_t GetBasketAndFirst(TBasket*& basket, Long64_t& first, TBuffer* user_buffer);
183 TBasket *GetBasketImpl(Int_t basket, TBuffer* user_buffer);
185 Int_t GetEntriesSerialized(Long64_t N, TBuffer& user_buf) {return GetEntriesSerialized(N, user_buf, nullptr);}
187 Int_t FillEntryBuffer(TBasket* basket,TBuffer* buf, Int_t& lnew);
189 TBranch(const TBranch&) = delete; // not implemented
190 TBranch& operator=(const TBranch&) = delete; // not implemented
191
192public:
193 TBranch();
194 TBranch(TTree *tree, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
195 TBranch(TBranch *parent, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit);
196 ~TBranch() override;
197
198 virtual void AddBasket(TBasket &b, bool ondisk, Long64_t startEntry);
199 virtual void AddLastBasket(Long64_t startEntry);
200 Int_t BackFill();
201 void Browse(TBrowser *b) override;
202 virtual void DeleteBaskets(Option_t* option="");
203 virtual void DropBaskets(Option_t *option = "");
204 void ExpandBasketArrays();
205 Int_t Fill() { return FillImpl(nullptr); }
207 virtual TBranch *FindBranch(const char *name);
208 virtual TLeaf *FindLeaf(const char *name);
211
212 virtual char *GetAddress() const {return fAddress;}
213 TBasket *GetBasket(Int_t basket) {return GetBasketImpl(basket, nullptr);}
216 virtual Long64_t GetBasketSeek(Int_t basket) const;
217 virtual Int_t GetBasketSize() const {return fBasketSize;}
219 virtual TList *GetBrowsables();
220 virtual const char* GetClassName() const;
225 virtual Int_t GetEntry(Long64_t entry=0, Int_t getall = 0);
226 virtual Int_t GetEntryExport(Long64_t entry, Int_t getall, TClonesArray *list, Int_t n);
228 Int_t GetEvent(Long64_t entry=0) {return GetEntry(entry);}
229 virtual TString GetFullName() const;
230 const char *GetIconName() const override;
231 virtual Int_t GetExpectedType(TClass *&clptr,EDataType &type);
232 virtual TLeaf *GetLeaf(const char *name) const;
233 virtual TFile *GetFile(Int_t mode=0);
234 const char *GetFileName() const {return fFileName.Data();}
235 Int_t GetOffset() const {return fOffset;}
249 Int_t GetNleaves() const {return fNleaves;}
251 Long64_t GetEntries() const {return fEntries;}
252 TTree *GetTree() const {return fTree;}
253 virtual Int_t GetRow(Int_t row);
254 virtual bool GetMakeClass() const;
255 TBranch *GetMother() const;
256 TBranch *GetSubBranch(const TBranch *br) const;
258 bool IsAutoDelete() const;
259 bool IsFolder() const override;
260 virtual void KeepCircular(Long64_t maxEntries);
261 virtual Int_t LoadBaskets();
262 void Print(Option_t *option="") const override;
263 void PrintCacheInfo() const;
264 virtual void ReadBasket(TBuffer &b);
265 virtual void Refresh(TBranch *b);
266 virtual void Reset(Option_t *option="");
267 virtual void ResetAfterMerge(TFileMergeInfo *);
268 virtual void ResetAddress();
269 virtual void ResetReadEntry() {fReadEntry = -1;}
270 virtual void SetAddress(void *add);
271 virtual void SetObject(void *objadd);
272 virtual void SetAutoDelete(bool autodel=true);
273 virtual void SetBasketSize(Int_t buffsize);
274 virtual void SetBufferAddress(TBuffer *entryBuffer);
278 virtual void SetEntries(Long64_t entries);
279 virtual void SetEntryOffsetLen(Int_t len, bool updateSubBranches = false);
280 virtual void SetFirstEntry(Long64_t entry);
281 virtual void SetFile(TFile *file = nullptr);
282 virtual void SetFile(const char *filename);
283 void SetIOFeatures(TIOFeatures &features) {fIOFeatures = features;}
284 virtual bool SetMakeClass(bool decomposeObj = true);
286 virtual void SetStatus(bool status=true);
287 virtual void SetTree(TTree *tree) { fTree = tree; }
288 virtual void SetupAddresses();
289 bool SupportsBulkRead() const;
290 virtual void UpdateAddress() {}
291 virtual void UpdateFile();
292
293 static void ResetCount();
294
295 ClassDefOverride(TBranch, 13); // Branch descriptor
296};
297
298//______________________________________________________________________________
300{
301 return (fCompress < 0) ? -1 : fCompress / 100;
302}
303
304//______________________________________________________________________________
306{
307 return (fCompress < 0) ? -1 : fCompress % 100;
308}
309
310//______________________________________________________________________________
312{
313 return (fCompress < 0) ? -1 : fCompress;
314}
315
316namespace ROOT {
317namespace Experimental {
318namespace Internal {
319
320inline Int_t TBulkBranchRead::GetBulkEntries(Long64_t evt, TBuffer& user_buf) { return fParent.GetBulkEntries(evt, user_buf); }
322inline Int_t TBulkBranchRead::GetEntriesSerialized(Long64_t evt, TBuffer& user_buf, TBuffer* count_buf) { return fParent.GetEntriesSerialized(evt, user_buf, count_buf); }
324
325} // Internal
326} // Experimental
327} // ROOT
328
329#endif
#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
long long Long64_t
Definition RtypesCore.h:80
const char Option_t
Definition RtypesCore.h:66
#define BIT(n)
Definition Rtypes.h:85
#define ClassDefOverride(name, id)
Definition Rtypes.h:341
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
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h offset
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t UChar_t len
Option_t Option_t TPoint TPoint const char mode
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition TGX11.cxx:110
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)
See TBranch::GetEntriesSerialized(Long64_t evt, TBuffer &user_buf);.
Definition TBranch.h:321
bool SupportsBulkRead() const
Return true if the branch can be read through the bulk interfaces.
Definition TBranch.h:323
Int_t GetBulkEntries(Long64_t evt, TBuffer &user_buf)
See TBranch::GetBulkEntries(Long64_t evt, TBuffer &user_buf);.
Definition TBranch.h:320
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...
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:93
virtual TLeaf * GetLeaf(const char *name) const
Return pointer to the 1st Leaf named name in thisBranch.
Definition TBranch.cxx:2055
virtual bool GetMakeClass() const
Return whether this branch is in a mode where the object are decomposed or not (Also known as MakeCla...
Definition TBranch.cxx:2117
virtual void SetupAddresses()
If the branch address is not set, we set all addresses starting with the top level parent branch.
Definition TBranch.cxx:3294
virtual void ResetAddress()
Reset the address of the branch.
Definition TBranch.cxx:2651
TString fFileName
Name of file where buffers are stored ("" if in same file as Tree header)
Definition TBranch.h:149
virtual const char * GetClassName() const
Return the name of the user class whose content is stored in this branch, if any.
Definition TBranch.cxx:1324
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:1894
TBasket * GetBasketImpl(Int_t basket, TBuffer *user_buffer)
Return pointer to basket basketnumber in this Branch.
Definition TBranch.cxx:1226
Int_t fEntryOffsetLen
Initial Length of fEntryOffset table in the basket buffers.
Definition TBranch.h:119
virtual void DeleteBaskets(Option_t *option="")
Loop on all branch baskets.
Definition TBranch.cxx:726
virtual Long64_t GetBasketSeek(Int_t basket) const
Return address of basket in the file.
Definition TBranch.cxx:1302
TBranch()
Default constructor. Used for I/O by default.
Definition TBranch.cxx:87
virtual char * GetAddress() const
Definition TBranch.h:212
void SetCompressionSettings(Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
Set compression settings.
Definition TBranch.cxx:2805
const char * GetIconName() const override
Return icon name depending on type of branch.
Definition TBranch.cxx:1332
Int_t BackFill()
Loop on all leaves of this branch to back fill Basket buffer.
Definition TBranch.cxx:680
Int_t GetCompressionSettings() const
Definition TBranch.h:311
~TBranch() override
Destructor.
Definition TBranch.cxx:450
Int_t GetCompressionLevel() const
Definition TBranch.h:305
Int_t GetCompressionAlgorithm() const
Definition TBranch.h:299
Int_t fMaxBaskets
Maximum number of Baskets so far.
Definition TBranch.h:125
Long64_t fTotBytes
Total number of bytes in all leaves before compression.
Definition TBranch.h:136
TBuffer * fTransientBuffer
! Pointer to the current transient buffer.
Definition TBranch.h:151
virtual void ReadBasket(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition TBranch.cxx:2453
TTree * GetTree() const
Definition TBranch.h:252
FillLeaves_t fFillLeaves
! Pointer to the FillLeaves implementation to use.
Definition TBranch.h:163
virtual TString GetFullName() const
Return the 'full' name of the branch.
Definition TBranch.cxx:2031
Int_t GetWriteBasket() const
Definition TBranch.h:238
void(TBranch::* ReadLeaves_t)(TBuffer &b)
Definition TBranch.h:160
EStatusBits
TBranch status bits.
Definition TBranch.h:104
@ kAutoDelete
Definition TBranch.h:110
@ 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:112
@ kBranchAny
Branch is an object*.
Definition TBranch.h:108
@ kIsClone
To indicate a TBranchClones.
Definition TBranch.h:106
@ kBranchObject
Branch is a TObject*.
Definition TBranch.h:107
@ kDoNotProcess
Active bit for branches.
Definition TBranch.h:105
TObjArray fLeaves
-> List of leaves of this branch
Definition TBranch.h:139
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:1353
char * fAddress
! Address of 1st leaf (variable or object)
Definition TBranch.h:147
virtual void DropBaskets(Option_t *option="")
Loop on all branch baskets.
Definition TBranch.cxx:757
TObjArray * GetListOfBranches()
Definition TBranch.h:246
virtual TList * GetBrowsables()
Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListO...
Definition TBranch.cxx:1312
TList * fBrowsables
! List of TVirtualBranchBrowsables used for Browse()
Definition TBranch.h:152
void ReadLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to read Basket buffer.
Definition TBranch.cxx:2461
virtual void SetTree(TTree *tree)
Definition TBranch.h:287
Int_t fOffset
Offset of this branch.
Definition TBranch.h:124
Long64_t * fBasketEntry
[fMaxBaskets] Table of first entry in each basket
Definition TBranch.h:142
Int_t GetEntriesSerialized(Long64_t N, TBuffer &user_buf)
Definition TBranch.h:185
ROOT::Experimental::Internal::TBulkBranchRead & GetBulkRead()
Definition TBranch.h:218
void ExpandBasketArrays()
Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size...
Definition TBranch.cxx:825
Int_t GetSplitLevel() const
Definition TBranch.h:250
ROOT::TIOFeatures TIOFeatures
Definition TBranch.h:94
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:1706
const char * GetFileName() const
Definition TBranch.h:234
TIOFeatures GetIOFeatures() const
Returns the IO settings currently in use for this branch.
Definition TBranch.cxx:2255
void FillLeavesImpl(TBuffer &b)
Loop on all leaves of this branch to fill Basket buffer.
Definition TBranch.cxx:2496
Long64_t fReadEntry
! Current entry number when reading
Definition TBranch.h:130
void Print(Option_t *option="") const override
Print TBranch parameters.
Definition TBranch.cxx:2341
static void ResetCount()
Static function resetting fgCount.
Definition TBranch.cxx:2674
TBranch * GetSubBranch(const TBranch *br) const
Find the parent branch of child.
Definition TBranch.cxx:2164
ReadLeaves_t fReadLeaves
! Pointer to the ReadLeaves implementation to use.
Definition TBranch.h:161
virtual void SetObject(void *objadd)
Set object this branch is pointing to.
Definition TBranch.cxx:2936
Int_t FlushBaskets()
Flush to disk all the baskets of this branch and any of subbranches.
Definition TBranch.cxx:1136
void ReadLeaves2Impl(TBuffer &b)
Read two leaves without the overhead of a loop.
Definition TBranch.cxx:2487
virtual void AddBasket(TBasket &b, bool ondisk, Long64_t startEntry)
Add the basket to this branch.
Definition TBranch.cxx:545
virtual void SetAddress(void *add)
Set address of this branch.
Definition TBranch.cxx:2682
static Int_t fgCount
! branch counter
Definition TBranch.h:116
void(TBranch::* FillLeaves_t)(TBuffer &b)
Definition TBranch.h:162
Int_t GetEvent(Long64_t entry=0)
Definition TBranch.h:228
virtual void AddLastBasket(Long64_t startEntry)
Add the start entry of the write basket (not yet created)
Definition TBranch.cxx:618
TBasket * GetBasket(Int_t basket)
Definition TBranch.h:213
Int_t fNBaskets
! Number of baskets in memory
Definition TBranch.h:126
void ReadLeaves1Impl(TBuffer &b)
Read one leaf without the overhead of a loop.
Definition TBranch.cxx:2479
Int_t GetNleaves() const
Definition TBranch.h:249
Int_t GetBulkEntries(Long64_t, TBuffer &)
Read a basket of events into the given buffer with byte swapping.
Definition TBranch.cxx:1472
virtual void SetFile(TFile *file=nullptr)
Set file where this branch writes/reads its buffers.
Definition TBranch.cxx:2863
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:1762
virtual void SetAutoDelete(bool autodel=true)
Set the automatic delete bit.
Definition TBranch.cxx:2716
Long64_t fZipBytes
Total number of bytes in all leaves after compression.
Definition TBranch.h:137
TIOFeatures fIOFeatures
IO features for newly-created baskets.
Definition TBranch.h:123
void Browse(TBrowser *b) override
Browser interface.
Definition TBranch.cxx:699
void SetCompressionAlgorithm(Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
Set compression algorithm.
Definition TBranch.cxx:2763
virtual void UpdateAddress()
Definition TBranch.h:290
Int_t GetOffset() const
Definition TBranch.h:235
virtual void SetEntryOffsetLen(Int_t len, bool updateSubBranches=false)
Update the default value for the branch's fEntryOffsetLen if and only if it was already non zero (and...
Definition TBranch.cxx:2821
virtual TLeaf * FindLeaf(const char *name)
Find the leaf corresponding to the name 'searchname'.
Definition TBranch.cxx:1081
BulkObj fBulk
! Helper for performing bulk IO
Definition TBranch.h:153
Long64_t GetReadEntry() const
Definition TBranch.h:237
CacheInfo_t fCacheInfo
! Hold info about which basket are in the cache and if they have been retrieved from the cache.
Definition TBranch.h:158
TObjArray * GetListOfBaskets()
Definition TBranch.h:245
virtual void SetBufferAddress(TBuffer *entryBuffer)
Set address of this branch directly from a TBuffer to avoid streaming.
Definition TBranch.cxx:2745
Long64_t GetEntries() const
Definition TBranch.h:251
Int_t fNleaves
! Number of leaves
Definition TBranch.h:128
Int_t fSplitLevel
Branch split level.
Definition TBranch.h:127
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:3202
virtual void UpdateFile()
Refresh the value of fDirectory (i.e.
Definition TBranch.cxx:3304
void SetSkipZip(bool skip=true)
Definition TBranch.h:170
Int_t GetReadBasket() const
Definition TBranch.h:236
Int_t * fBasketBytes
[fMaxBaskets] Length of baskets on file
Definition TBranch.h:141
Long64_t fNextBasketEntry
! Next entry that will requires us to go to the next basket
Definition TBranch.h:132
bool IsAutoDelete() const
Return true if an existing object in a TBranchObject must be deleted.
Definition TBranch.cxx:2263
Int_t GetMaxBaskets() const
Definition TBranch.h:248
Int_t * GetBasketBytes() const
Definition TBranch.h:214
TBranch & operator=(const TBranch &)=delete
Int_t FillEntryBuffer(TBasket *basket, TBuffer *buf, Int_t &lnew)
Copy the data from fEntryBuffer into the current basket.
Definition TBranch.cxx:935
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:1853
TObjArray fBranches
-> List of Branches of this branch
Definition TBranch.h:138
virtual void KeepCircular(Long64_t maxEntries)
keep a maximum of fMaxEntries in memory
Definition TBranch.cxx:2283
virtual void SetStatus(bool status=true)
Set branch status to Process or DoNotProcess.
Definition TBranch.cxx:2947
virtual void ResetAfterMerge(TFileMergeInfo *)
Reset a Branch.
Definition TBranch.cxx:2598
void ReadLeaves0Impl(TBuffer &b)
Read zero leaves without the overhead of a loop.
Definition TBranch.cxx:2472
bool SupportsBulkRead() const
Returns true if this branch supports bulk IO, false otherwise.
Definition TBranch.cxx:1431
virtual void ResetReadEntry()
Definition TBranch.h:269
TString GetRealFileName() const
Get real file name.
Definition TBranch.cxx:2068
virtual TBranch * FindBranch(const char *name)
Find the immediate sub-branch with passed name.
Definition TBranch.cxx:1035
TBranch(const TBranch &)=delete
TDirectory * fDirectory
! Pointer to directory where this branch buffers are stored
Definition TBranch.h:148
void PrintCacheInfo() const
Print the information we have about which basket is currently cached and whether they have been 'used...
Definition TBranch.cxx:2445
TObjArray fBaskets
-> List of baskets of this branch
Definition TBranch.h:140
virtual void SetAddressImpl(void *addr, bool)
Definition TBranch.h:179
virtual Int_t LoadBaskets()
Baskets associated to this branch are forced to be in memory.
Definition TBranch.cxx:2309
void SetIOFeatures(TIOFeatures &features)
Definition TBranch.h:283
TBranch * fMother
! Pointer to top-level parent branch in the tree.
Definition TBranch.h:145
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:2220
TBranch * fParent
! Pointer to parent branch.
Definition TBranch.h:146
Int_t WriteBasket(TBasket *basket, Int_t where)
Definition TBranch.h:175
virtual void SetOffset(Int_t offset=0)
Definition TBranch.h:285
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:1182
bool fSkipZip
! After being read, the buffer will not be unzipped.
Definition TBranch.h:155
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:1834
virtual Int_t GetBasketSize() const
Definition TBranch.h:217
bool IsFolder() const override
Return true if more than one leaf or browsables, false otherwise.
Definition TBranch.cxx:2271
virtual void SetFirstEntry(Long64_t entry)
set the first entry number (case of TBranchSTL)
Definition TBranch.cxx:3279
Long64_t GetTotalSize(Option_t *option="") const
Return total number of bytes in the branch (including current buffer)
Definition TBranch.cxx:2201
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:2238
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:2729
virtual void Refresh(TBranch *b)
Refresh this branch using new information in b This function is called by TTree::Refresh.
Definition TBranch.cxx:2508
virtual bool SetMakeClass(bool decomposeObj=true)
Set the branch in a mode where the object are decomposed (Also known as MakeClass mode).
Definition TBranch.cxx:2927
Int_t fWriteBasket
Last basket number written.
Definition TBranch.h:120
Long64_t * fBasketSeek
[fMaxBaskets] Addresses of baskets on file
Definition TBranch.h:143
Long64_t GetEntryNumber() const
Definition TBranch.h:242
TObjArray * GetListOfLeaves()
Definition TBranch.h:247
virtual void SetEntries(Long64_t entries)
Set the number of entries in this branch.
Definition TBranch.cxx:2838
Int_t fReadBasket
! Current basket number when reading
Definition TBranch.h:129
TDirectory * GetDirectory() const
Definition TBranch.h:224
Long64_t fFirstEntry
Number of the first entry in this branch.
Definition TBranch.h:135
TBasket * fExtraBasket
! Allocated basket not currently holding any data.
Definition TBranch.h:122
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:2108
Long64_t GetFirstEntry() const
Definition TBranch.h:243
Int_t fBasketSize
Initial Size of Basket Buffer.
Definition TBranch.h:118
Int_t Fill()
Definition TBranch.h:205
virtual void Reset(Option_t *option="")
Reset a Branch.
Definition TBranch.cxx:2557
Long64_t fEntryNumber
Current entry number (last one filled in this branch)
Definition TBranch.h:121
TBranch * GetMother() const
Get our top-level parent branch in the tree.
Definition TBranch.cxx:2127
Int_t fCompress
Compression level and algorithm.
Definition TBranch.h:117
TBuffer * GetTransientBuffer(Int_t size)
Returns the transient buffer currently used by this TBranch for reading/writing baskets.
Definition TBranch.cxx:523
virtual Int_t FillImpl(ROOT::Internal::TBranchIMTHelper *)
Loop on all leaves of this branch to fill Basket buffer.
Definition TBranch.cxx:856
TBuffer * fEntryBuffer
! Buffer used to directly pass the content without streaming
Definition TBranch.h:150
TBasket * fCurrentBasket
! Pointer to the current basket.
Definition TBranch.h:133
Long64_t fFirstBasketEntry
! First entry in the current basket.
Definition TBranch.h:131
void SetCompressionLevel(Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
Set compression level.
Definition TBranch.cxx:2783
Long64_t * GetBasketEntry() const
Definition TBranch.h:215
Int_t GetEntryOffsetLen() const
Definition TBranch.h:227
Long64_t fEntries
Number of entries.
Definition TBranch.h:134
TBasket * GetFreshCluster(TBuffer *user_buffer)
Drops the cluster two behind the current cluster and returns a fresh basket by either reusing or crea...
Definition TBranch.cxx:1953
TTree * fTree
! Pointer to Tree header
Definition TBranch.h:144
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:81
An array of clone (identical) objects.
Describe directory structure in memory.
Definition TDirectory.h:45
A ROOT file is composed of a header, followed by consecutive data records (TKey instances) with a wel...
Definition TFile.h:53
A TLeaf describes individual elements of a TBranch See TBranch structure in TTree.
Definition TLeaf.h:57
A doubly linked list.
Definition TList.h:38
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
An array of TObjects.
Definition TObjArray.h:31
Basic string class.
Definition TString.h:139
const char * Data() const
Definition TString.h:378
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
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.
@ kUseGlobal
Use the global compression algorithm.
Definition Compression.h:90
@ kInherit
Some objects use this value to denote that the compression algorithm should be inherited from the par...
Definition Compression.h:88
@ kUseCompiledDefault
Use the compile-time default setting.
Definition Compression.h:52
@ kUseMin
Compression level reserved when we are not sure what to use (1 is for the fastest compression)
Definition Compression.h:70