Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
TBranch Class Reference

A TTree is a list of TBranches.

A TBranch supports:

  • The list of TLeaf describing this branch.
  • The list of TBasket (branch buffers).

See TBranch structure in TTree.

See also specialized branches:

  • TBranchObject in case the branch is one object
  • TBranchClones in case the branch is an array of clone objects

Definition at line 93 of file TBranch.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
using TIOFeatures = ROOT::TIOFeatures

Public Member Functions

 TBranch ()
 Default constructor. Used for I/O by default.
 TBranch (TBranch *parent, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress=ROOT::RCompressionSetting::EAlgorithm::kInherit)
 Create a Branch as a child of another Branch.
 TBranch (TTree *tree, const char *name, void *address, const char *leaflist, Int_t basketsize=32000, Int_t compress=ROOT::RCompressionSetting::EAlgorithm::kInherit)
 Create a Branch as a child of a Tree.
 ~TBranch () override
 Destructor.
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
virtual void AddBasket (TBasket &b, bool ondisk, Long64_t startEntry)
 Add the basket to this branch.
virtual void AddLastBasket (Long64_t startEntry)
 Add the start entry of the write basket (not yet created).
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
Int_t BackFill ()
 Loop on all leaves of this branch to back fill Basket buffer.
void Browse (TBrowser *b) override
 Browser interface.
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
void Copy (TAttFill &attfill) const
void Copy (TObject &named) const override
 Copy this to obj.
virtual void Delete (Option_t *option="")
 Delete this object.
virtual void DeleteBaskets (Option_t *option="")
 Loop on all branch baskets.
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
virtual void DropBaskets (Option_t *option="")
 Loop on all branch baskets.
virtual void Dump () const
 Dump contents of object on stdout.
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
void ExpandBasketArrays ()
 Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size.
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
Int_t Fill ()
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual Int_t FillImpl (ROOT::Internal::TBranchIMTHelper *)
 Loop on all leaves of this branch to fill Basket buffer.
virtual TBranchFindBranch (const char *name)
 Find the immediate sub-branch with passed name.
virtual TLeafFindLeaf (const char *name)
 Find the leaf corresponding to the name 'searchname'.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
Int_t FlushBaskets ()
 Flush to disk all the baskets of this branch and any of subbranches.
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, we write it and delete it from memory.
virtual char * GetAddress () const
TBasketGetBasket (Int_t basket)
Int_tGetBasketBytes () const
Long64_tGetBasketEntry () const
virtual Long64_t GetBasketSeek (Int_t basket) const
 Return address of basket in the file.
virtual Int_t GetBasketSize () const
virtual TListGetBrowsables ()
 Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListOfBrowsables.
ROOT::Experimental::Internal::TBulkBranchReadGetBulkRead ()
virtual const char * GetClassName () const
 Return the name of the user class whose content is stored in this branch, if any.
Int_t GetCompressionAlgorithm () const
Int_t GetCompressionLevel () const
Int_t GetCompressionSettings () const
TDirectoryGetDirectory () const
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
Long64_t GetEntries () const
virtual Int_t GetEntry (Long64_t entry=0, Int_t getall=0)
 Read all leaves of entry and return total number of bytes read.
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.
Long64_t GetEntryNumber () const
Int_t GetEntryOffsetLen () const
Int_t GetEvent (Long64_t entry=0)
virtual Int_t GetExpectedType (TClass *&clptr, EDataType &type)
 Fill expectedClass and expectedType with information on the data type of the object/values contained in this branch (and thus the type of pointers expected to be passed to Set[Branch]Address return 0 in case of success and > 0 in case of failure.
virtual TFileGetFile (Int_t mode=0)
 Return pointer to the file where branch buffers reside, returns 0 in case branch buffers reside in the same file as tree header.
const char * GetFileName () const
virtual Color_t GetFillColor () const
 Return the fill area color.
virtual Style_t GetFillStyle () const
 Return the fill area style.
Long64_t GetFirstEntry () const
virtual TString GetFullName () const
 Return the 'full' name of the branch.
const char * GetIconName () const override
 Return icon name depending on type of branch.
TIOFeatures GetIOFeatures () const
 Returns the IO settings currently in use for this branch.
virtual TLeafGetLeaf (const char *name) const
 Return pointer to the 1st Leaf named name in thisBranch.
TObjArrayGetListOfBaskets ()
TObjArrayGetListOfBranches ()
TObjArrayGetListOfLeaves ()
virtual bool GetMakeClass () const
 Return whether this branch is in a mode where the object are decomposed or not (Also known as MakeClass mode).
Int_t GetMaxBaskets () const
TBranchGetMother () const
 Get our top-level parent branch in the tree.
const char * GetName () const override
 Returns name of object.
Int_t GetNleaves () const
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
Int_t GetOffset () const
virtual Option_tGetOption () const
Int_t GetReadBasket () const
Long64_t GetReadEntry () const
virtual Int_t GetRow (Int_t row)
 Return all elements of one row unpacked in internal array fValues [Actually just returns 1 (?)].
Int_t GetSplitLevel () const
TBranchGetSubBranch (const TBranch *br) const
 Find the parent branch of child.
const char * GetTitle () const override
 Returns title of object.
Long64_t GetTotalSize (Option_t *option="") const
 Return total number of bytes in the branch (including current buffer).
Long64_t GetTotBytes (Option_t *option="") const
 Return total number of bytes in the branch (excluding current buffer) if option ="*" includes all sub-branches of this branch too.
TBufferGetTransientBuffer (Int_t size)
 Returns the transient buffer currently used by this TBranch for reading/writing baskets.
TTreeGetTree () const
virtual UInt_t GetUniqueID () const
 Return the unique object id.
Int_t GetWriteBasket () const
Long64_t GetZipBytes (Option_t *option="") const
 Return total number of zip bytes in the branch if option ="*" includes all sub-branches of this branch too.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
ULong_t Hash () const override
 Return hash value for this object.
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
TClassIsA () const override
bool IsAutoDelete () const
 Return true if an existing object in a TBranchObject must be deleted.
Bool_t IsDestructed () const
 IsDestructed.
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
bool IsFolder () const override
 Return true if more than one leaf or browsables, false otherwise.
Bool_t IsOnHeap () const
Bool_t IsSortable () const override
virtual Bool_t IsTransparent () const
Bool_t IsZombie () const
virtual void KeepCircular (Long64_t maxEntries)
 keep a maximum of fMaxEntries in memory
virtual Int_t LoadBaskets ()
 Baskets associated to this branch are forced to be in memory.
void ls (Option_t *option="") const override
 List TNamed name and title.
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual void Modify ()
virtual void ModifyOn (TVirtualPad &pad)
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
void operator delete (void *ptr)
 Operator delete.
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
void operator delete[] (void *, size_t)
 Operator delete [] for sized deallocation.
void operator delete[] (void *ptr)
 Operator delete [].
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
void * operator new (size_t sz)
void * operator new (size_t sz, void *vp)
void * operator new[] (size_t sz)
void * operator new[] (size_t sz, void *vp)
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
void Print (Option_t *option="") const override
 Print TBranch parameters.
void PrintCacheInfo () const
 Print the information we have about which basket is currently cached and whether they have been 'used'/'read' from the cache.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
virtual void ReadBasket (TBuffer &b)
 Loop on all leaves of this branch to read Basket buffer.
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
virtual void Refresh (TBranch *b)
 Refresh this branch using new information in b This function is called by TTree::Refresh.
virtual void Reset (Option_t *option="")
 Reset a Branch.
virtual void ResetAddress ()
 Reset the address of the branch.
virtual void ResetAfterMerge (TFileMergeInfo *)
 Reset a Branch.
virtual void ResetAttFill (Option_t *option="")
void ResetBit (UInt_t f)
virtual void ResetReadEntry ()
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
virtual void SetAddress (void *add)
 Set address of this branch.
virtual void SetAutoDelete (bool autodel=true)
 Set the automatic delete bit.
virtual void SetBasketSize (Int_t bufsize)
 Set the basket size The function makes sure that the basket size is greater than fEntryOffsetlen.
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
virtual void SetBufferAddress (TBuffer *entryBuffer)
 Set address of this branch directly from a TBuffer to avoid streaming.
void SetCompressionAlgorithm (Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
 Set compression algorithm.
void SetCompressionLevel (Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
 Set compression level.
void SetCompressionSettings (Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
 Set compression settings.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
virtual void SetEntries (Long64_t entries)
 Set the number of entries in this branch.
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 the new value is not zero) If updateExisting is true, also update all the existing branches.
virtual void SetFile (const char *filename)
 Set file where this branch writes/reads its buffers.
virtual void SetFile (TFile *file=nullptr)
 Set file where this branch writes/reads its buffers.
virtual void SetFillAttributes ()
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color.
void SetFillColor (TColorNumber)
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style.
virtual void SetFirstEntry (Long64_t entry)
 set the first entry number (case of TBranchSTL)
void SetIOFeatures (TIOFeatures &features)
virtual bool SetMakeClass (bool decomposeObj=true)
 Set the branch in a mode where the object are decomposed (Also known as MakeClass mode).
virtual void SetName (const char *name)
 Set the name of the TNamed.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
virtual void SetObject (void *objadd)
 Set object this branch is pointing to.
virtual void SetOffset (Int_t offset=0)
virtual void SetStatus (bool status=true)
 Set branch status to Process or DoNotProcess.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual void SetTree (TTree *tree)
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
virtual void SetupAddresses ()
 If the branch address is not set, we set all addresses starting with the top level parent branch.
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
void Streamer (TBuffer &) override
 Stream a class object.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
bool SupportsBulkRead () const
 Returns true if this branch supports bulk IO, false otherwise.
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
virtual void UpdateAddress ()
virtual void UpdateFile ()
 Refresh the value of fDirectory (i.e.
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static void ResetCount ()
 Static function resetting fgCount.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }
using BulkObj = ROOT::Experimental::Internal::TBulkBranchRead
using CacheInfo_t = ROOT::Internal::TBranchCacheInfo
enum  EStatusBits {
  kDoNotProcess = ::kDoNotProcess , kIsClone = ::kIsClone , kBranchObject = ::kBranchObject , kBranchAny = ::kBranchAny ,
  kAutoDelete = (1ULL << (15)) , kDoNotUseBufferMap = (1ULL << (22))
}
 TBranch status bits. More...
typedef void(TBranch::* FillLeaves_t) (TBuffer &b)
typedef void(TBranch::* ReadLeaves_t) (TBuffer &b)

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void FillLeavesImpl (TBuffer &b)
 Loop on all leaves of this branch to fill Basket buffer.
TBasketGetFreshBasket (Int_t basketnumber, TBuffer *user_buffer)
 Return a fresh basket by either reusing an existing basket that needs to be drop (according to TTree::MemoryFull) or create a new one.
TBasketGetFreshCluster (TBuffer *user_buffer)
 Drops the cluster two behind the current cluster and returns a fresh basket by either reusing or creating a new one.
TString GetRealFileName () const
 Get real file name.
void Init (const char *name, const char *leaflist, Int_t compress)
void MakeZombie ()
void ReadLeaves0Impl (TBuffer &b)
 Read zero leaves without the overhead of a loop.
void ReadLeaves1Impl (TBuffer &b)
 Read one leaf without the overhead of a loop.
void ReadLeaves2Impl (TBuffer &b)
 Read two leaves without the overhead of a loop.
void ReadLeavesImpl (TBuffer &b)
 Loop on all leaves of this branch to read Basket buffer.
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
virtual void SetAddressImpl (void *addr, bool, Int_t)
void SetSkipZip (bool skip=true)
Int_t WriteBasket (TBasket *basket, Int_t where)

Static Protected Member Functions

static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

char * fAddress
 ! Address of 1st leaf (variable or object)
Int_tfBasketBytes
 [fMaxBaskets] Length of baskets on file
Long64_tfBasketEntry
 [fMaxBaskets] Table of first entry in each basket
TObjArray fBaskets
 -> List of baskets of this branch
Long64_tfBasketSeek
 [fMaxBaskets] Addresses of baskets on file
Int_t fBasketSize
 Initial Size of Basket Buffer.
TObjArray fBranches
 -> List of Branches of this branch
TListfBrowsables
 ! List of TVirtualBranchBrowsables used for Browse()
BulkObj fBulk
 ! Helper for performing bulk IO
CacheInfo_t fCacheInfo
 ! Hold info about which basket are in the cache and if they have been retrieved from the cache.
Int_t fCompress
 Compression level and algorithm.
TBasketfCurrentBasket
 ! Pointer to the current basket.
TDirectoryfDirectory
 ! Pointer to directory where this branch buffers are stored
Long64_t fEntries
 Number of entries.
TBufferfEntryBuffer
 ! Buffer used to directly pass the content without streaming
Long64_t fEntryNumber
 Current entry number (last one filled in this branch).
Int_t fEntryOffsetLen
 Initial Length of fEntryOffset table in the basket buffers.
TBasketfExtraBasket
 ! Allocated basket not currently holding any data.
TString fFileName
 Name of file where buffers are stored ("" if in same file as Tree header).
Color_t fFillColor
 Fill area color.
FillLeaves_t fFillLeaves
 ! Pointer to the FillLeaves implementation to use.
Style_t fFillStyle
 Fill area style.
Long64_t fFirstBasketEntry
 ! First entry in the current basket.
Long64_t fFirstEntry
 Number of the first entry in this branch.
TIOFeatures fIOFeatures
 IO features for newly-created baskets.
TObjArray fLeaves
 -> List of leaves of this branch
Int_t fMaxBaskets
 Maximum number of Baskets so far.
TBranchfMother
 ! Pointer to top-level parent branch in the tree.
TString fName
Int_t fNBaskets
 ! Number of baskets in memory
Long64_t fNextBasketEntry
 ! Next entry that will requires us to go to the next basket
Int_t fNleaves
 ! Number of leaves
Int_t fOffset
 Offset of this branch.
TBranchfParent
 ! Pointer to parent branch.
Int_t fReadBasket
 ! Current basket number when reading
Long64_t fReadEntry
 ! Current entry number when reading
ReadLeaves_t fReadLeaves
 ! Pointer to the ReadLeaves implementation to use.
bool fSkipZip
 ! After being read, the buffer will not be unzipped.
Int_t fSplitLevel
 Branch split level.
TString fTitle
Long64_t fTotBytes
 Total number of bytes in all leaves before compression.
TBufferfTransientBuffer
 ! Pointer to the current transient buffer.
TTreefTree
 ! Pointer to Tree header
Int_t fWriteBasket
 Last basket number written.
Long64_t fZipBytes
 Total number of bytes in all leaves after compression.

Static Protected Attributes

static Int_t fgCount = 0
 ! branch counter

Private Member Functions

 TBranch (const TBranch &)=delete
Int_t FillEntryBuffer (TBasket *basket, TBuffer *buf, Int_t &lnew)
 Copy the data from fEntryBuffer into the current basket.
Int_t GetBasketAndFirst (TBasket *&basket, Long64_t &first, TBuffer *user_buffer)
 A helper function to locate the correct basket - and its first entry.
TBasketGetBasketImpl (Int_t basket, TBuffer *user_buffer)
 Return pointer to basket basketnumber in this Branch.
Int_t GetBulkEntries (Long64_t, TBuffer &)
 Read a basket of events into the given buffer with byte swapping.
Int_t GetEntriesSerialized (Long64_t N, TBuffer &user_buf)
Int_t GetEntriesSerialized (Long64_t, TBuffer &, TBuffer *)
 Read a basket of events into the given buffer without byte swapping.
TBranchoperator= (const TBranch &)=delete
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.

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes

UInt_t fBits
 bit field status word
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable

Friends

class ROOT::Experimental::Internal::TBulkBranchRead
class TBranchElement
class TTree
class TTreeCache
class TTreeCloner

#include <TBranch.h>

Inheritance diagram for TBranch:
TNamed TAttFill TObject TBranchClones TBranchElement TBranchObject TBranchRef TBranchSTL THbookBranch

Member Typedef Documentation

◆ BulkObj

Definition at line 124 of file TBranch.h.

◆ CacheInfo_t

Definition at line 166 of file TBranch.h.

◆ FillLeaves_t

typedef void(TBranch::* TBranch::FillLeaves_t) (TBuffer &b)
protected

Definition at line 171 of file TBranch.h.

◆ ReadLeaves_t

typedef void(TBranch::* TBranch::ReadLeaves_t) (TBuffer &b)
protected

Definition at line 169 of file TBranch.h.

◆ TIOFeatures

Definition at line 95 of file TBranch.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TBranch::EStatusBits
protected

TBranch status bits.

Enumerator
kDoNotProcess 

Active bit for branches.

kIsClone 

To indicate a TBranchClones.

kBranchObject 

Branch is a TObject*.

kBranchAny 

Branch is an object*.

kAutoDelete 
kDoNotUseBufferMap 

If set, at least one of the entry in the branch will use the buffer's map of classname and objects.

Definition at line 105 of file TBranch.h.

Constructor & Destructor Documentation

◆ TBranch() [1/4]

TBranch::TBranch ( const TBranch & )
privatedelete

◆ TBranch() [2/4]

TBranch::TBranch ( )

Default constructor. Used for I/O by default.

Definition at line 86 of file TBranch.cxx.

◆ TBranch() [3/4]

TBranch::TBranch ( TTree * tree,
const char * name,
void * address,
const char * leaflist,
Int_t basketsize = 32000,
Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit )

Create a Branch as a child of a Tree.

  • address is the address of the first item of a structure or the address of a pointer to an object (see example in TTree.cxx).
  • leaflist is the concatenation of all the variable names and types separated by a colon character : The variable name and the variable type are separated by a slash (/). The variable type must be 1 character. (Characters after the first are legal and will be appended to the visible name of the leaf, but have no effect.) If no type is given, the type of the variable is assumed to be the same as the previous variable. If the first variable does not have a type, it is assumed of type F by default. The list of currently supported types is given below:

    • C : a character string terminated by the 0 character
    • B : an 8 bit signed integer (Char_t); Treated as a character when in an array.
    • b : an 8 bit unsigned integer (UChar_t)
    • S : a 16 bit signed integer (Short_t)
    • s : a 16 bit unsigned integer (UShort_t)
    • I : a 32 bit signed integer (Int_t)
    • i : a 32 bit unsigned integer (UInt_t)
    • F : a 32 bit floating point (Float_t)
    • f : a 24 bit floating point with truncated mantissa (Float16_t)
    • D : a 64 bit floating point (Double_t)
    • d : a 24 bit truncated floating point (Double32_t)
    • L : a 64 bit signed integer (Long64_t)
    • l : a 64 bit unsigned integer (ULong64_t)
    • G : a long signed integer (Long_t, which sizeof is platform dependent), stored as a 64 bit integer but usually held in memory as a 64 bit integer on 64 bit machines and 32 bit on 32 bit machines. Due to this difference, this data type is not cross-platform.
    • g : a long unsigned integer (ULong_t, which sizeof is platform dependent), stored as a 64 bit unsigned integer but held in memory usually as a 64 bit integer on 64 bit machines and 32 bit on 32 bit machines. Due to this difference, this data type is not cross-platform.
    • O : [the letter o, not a zero] a boolean (bool)

    Arrays of values are supported with the following syntax:

    • If leaf name has the form var[nelem], where nelem is alphanumeric, then if nelem is a leaf name, it is used as the variable size of the array, otherwise return 0. The leaf referred to by nelem MUST be an int (/I),
    • If leaf name has the form var[nelem], where nelem is a non-negative integers, then it is used as the fixed size of the array.
    • If leaf name has the form of a multi dimension array (e.g. var[nelem][nelem2]) where nelem and nelem2 are non-negative integers) then it is used as a 2 dimensional array of fixed size.
    • In case of the truncated floating point types (Float16_t and Double32_t) you can furthermore specify the range in the style [xmin,xmax] or [xmin,xmax,nbits] after the type character. See TStreamerElement::GetRange() for further information.
    • Any of other form is not supported.

    Note that the TTree will assume that all the item are contiguous in memory. On some platform, this is not always true of the member of a struct or a class, due to padding and alignment. Sorting your data member in order of decreasing sizeof usually leads to their being contiguous in memory.

  • bufsize is the buffer size in bytes for this branch The default value is 32000 bytes and should be ok for most cases. You can specify a larger value (e.g. 256000) if your Tree is not split and each entry is large (Megabytes) A small value for bufsize is optimum if you intend to access the entries in the Tree randomly and your Tree is in split mode.

See an example of a Branch definition in the TTree constructor.

Note that in case the data type is an object, this branch can contain only this object.

Note that this function is invoked by TTree::Branch

Definition at line 198 of file TBranch.cxx.

◆ TBranch() [4/4]

TBranch::TBranch ( TBranch * parent,
const char * name,
void * address,
const char * leaflist,
Int_t basketsize = 32000,
Int_t compress = ROOT::RCompressionSetting::EAlgorithm::kInherit )

Create a Branch as a child of another Branch.

See documentation for TBranch::TBranch(TTree *, const char *, void *, const char *, Int_t, Int_t)

Definition at line 251 of file TBranch.cxx.

◆ ~TBranch()

TBranch::~TBranch ( )
override

Destructor.

Definition at line 449 of file TBranch.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddBasket()

void TBranch::AddBasket ( TBasket & b,
bool ondisk,
Long64_t startEntry )
virtual

Add the basket to this branch.

Warning: if the basket are not 'flushed/copied' in the same order as they were created, this will induce a slow down in the insert (since we'll need to move all the record that are entere 'too early'). Warning we also assume that the current write basket is not present (aka has been removed) or is empty (no entries).

Definition at line 544 of file TBranch.cxx.

◆ AddLastBasket()

void TBranch::AddLastBasket ( Long64_t startEntry)
virtual

Add the start entry of the write basket (not yet created).

Definition at line 617 of file TBranch.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ BackFill()

Int_t TBranch::BackFill ( )

Loop on all leaves of this branch to back fill Basket buffer.

Use this routine instead of TBranch::Fill when filling a branch individually to catch up with the number of entries already in the TTree.

First it calls TBranch::Fill and then if the number of entries of the branch reach one of TTree cluster's boundary, the basket is flushed.

The function returns the number of bytes committed to the memory basket. If a write error occurs, the number of bytes returned is -1. If no data are written, because e.g. the branch is disabled, the number of bytes returned is 0.

To insure that the baskets of each cluster are located close by in the file, when back-filling multiple branches make sure to call BackFill for the same entry for all the branches consecutively

for( auto e = 0; e < tree->GetEntries(); ++e ) { // loop over entries.
for( auto branch : branchCollection) {
... Make change to the data associated with the branch ...
branch->BackFill();
}
}
// Since we loop over all the branches for each new entry
// all the baskets for a cluster are consecutive in the file.
#define e(i)
Definition RSha256.hxx:103

rather than doing all the entries of one branch at a time.

// Do NOT do things in the following order, it will lead to
// poorly clustered files.
for(auto branch : branchCollection) {
for( auto e = 0; e < tree->GetEntries(); ++e ) { // loop over entries.
... Make change to the data associated with the branch ...
branch->BackFill();
}
}
// Since we loop over all the entries for one branch
// all the baskets for that branch are consecutive.

Definition at line 679 of file TBranch.cxx.

◆ Browse()

void TBranch::Browse ( TBrowser * b)
overridevirtual

Browser interface.

Reimplemented from TObject.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and THbookBranch.

Definition at line 698 of file TBranch.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * TBranch::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

const char * TBranch::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TBranch::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 304 of file TBranch.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TNamed::Clear ( Option_t * option = "")
overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "") const
overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Copy() [1/2]

void TAttFill::Copy ( TAttFill & attfill) const
inherited

◆ Copy() [2/2]

void TNamed::Copy ( TObject & named) const
overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

◆ DeclFileName()

const char * TBranch::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 304 of file TBranch.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ DeleteBaskets()

void TBranch::DeleteBaskets ( Option_t * option = "")
virtual

Loop on all branch baskets.

If the file where branch buffers reside is writable, free the disk space associated to the baskets of the branch, then call Reset(). If the option contains "all", delete also the baskets for the subbranches. The branch is reset.

NOTE that this function must be used with extreme care. Deleting branch baskets fragments the file and may introduce inefficiencies when adding new entries in the Tree or later on when reading the Tree.

Definition at line 725 of file TBranch.cxx.

◆ DistancetoPrimitive()

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ DropBaskets()

void TBranch::DropBaskets ( Option_t * options = "")
virtual

Loop on all branch baskets.

Drop all baskets from memory except readbasket. If the option contains "all", drop all baskets including read- and write-baskets (unless they are not stored individually on disk). The option "all" also lead to DropBaskets being called on the sub-branches.

Definition at line 756 of file TBranch.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
Style_t fFillStyle
Fill area style.
Definition TAttFill.h:25
Color_t fFillColor
Fill area color.
Definition TAttFill.h:24
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ ExpandBasketArrays()

void TBranch::ExpandBasketArrays ( )

Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size.

Definition at line 824 of file TBranch.cxx.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ Fill()

Int_t TBranch::Fill ( )
inline

Definition at line 214 of file TBranch.h.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ FillEntryBuffer()

Int_t TBranch::FillEntryBuffer ( TBasket * basket,
TBuffer * buf,
Int_t & lnew )
private

Copy the data from fEntryBuffer into the current basket.

Definition at line 934 of file TBranch.cxx.

◆ FillImpl()

Int_t TBranch::FillImpl ( ROOT::Internal::TBranchIMTHelper * imtHelper)
virtual

Loop on all leaves of this branch to fill Basket buffer.

If TBranchIMTHelper is non-null and it is time to WriteBasket, then we will use TBB to compress in parallel.

The function returns the number of bytes committed to the memory basket. If a write error occurs, the number of bytes returned is -1. If no data are written, because e.g. the branch is disabled, the number of bytes returned is 0.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchRef, and TBranchSTL.

Definition at line 855 of file TBranch.cxx.

◆ FillLeavesImpl()

void TBranch::FillLeavesImpl ( TBuffer & b)
protected

Loop on all leaves of this branch to fill Basket buffer.

Definition at line 2495 of file TBranch.cxx.

◆ FindBranch()

TBranch * TBranch::FindBranch ( const char * name)
virtual

Find the immediate sub-branch with passed name.

Reimplemented in TBranchElement.

Definition at line 1034 of file TBranch.cxx.

◆ FindLeaf()

TLeaf * TBranch::FindLeaf ( const char * name)
virtual

Find the leaf corresponding to the name 'searchname'.

Reimplemented in TBranchElement.

Definition at line 1080 of file TBranch.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ FlushBaskets()

Int_t TBranch::FlushBaskets ( )

Flush to disk all the baskets of this branch and any of subbranches.

Return the number of bytes written or -1 in case of write error.

Definition at line 1135 of file TBranch.cxx.

◆ FlushOneBasket()

Int_t TBranch::FlushOneBasket ( UInt_t ibasket)

If we have a write basket in memory and it contains some entries and has not yet been written to disk, we write it and delete it from memory.

Return the number of bytes written;

Definition at line 1181 of file TBranch.cxx.

◆ GetAddress()

virtual char * TBranch::GetAddress ( ) const
inlinevirtual

Reimplemented in TBranchElement.

Definition at line 221 of file TBranch.h.

◆ GetBasket()

TBasket * TBranch::GetBasket ( Int_t basket)
inline

Definition at line 222 of file TBranch.h.

◆ GetBasketAndFirst()

Int_t TBranch::GetBasketAndFirst ( TBasket *& basket,
Long64_t & first,
TBuffer * user_buffer )
private

A helper function to locate the correct basket - and its first entry.

Extracted to a common private function because it is needed by both GetEntry and GetBulkEntries. It should not be called directly.

If a new basket must be constructed and the user_buffer is provided, then the user_buffer will back the memory of the newly-constructed basket.

Assumes that this branch is enabled.

Returns -1 if the entry does not exist Returns -2 in case of error Returns the index of the basket in case of success.

Definition at line 1352 of file TBranch.cxx.

◆ GetBasketBytes()

Int_t * TBranch::GetBasketBytes ( ) const
inline

Definition at line 223 of file TBranch.h.

◆ GetBasketEntry()

Long64_t * TBranch::GetBasketEntry ( ) const
inline

Definition at line 224 of file TBranch.h.

◆ GetBasketImpl()

TBasket * TBranch::GetBasketImpl ( Int_t basketnumber,
TBuffer * user_buffer )
private

Return pointer to basket basketnumber in this Branch.

If a new buffer must be created and the user_buffer argument is non-null, then the memory in the user_buffer will be shared with the returned TBasket.

Definition at line 1225 of file TBranch.cxx.

◆ GetBasketSeek()

Long64_t TBranch::GetBasketSeek ( Int_t basket) const
virtual

Return address of basket in the file.

Definition at line 1301 of file TBranch.cxx.

◆ GetBasketSize()

virtual Int_t TBranch::GetBasketSize ( ) const
inlinevirtual

Definition at line 226 of file TBranch.h.

◆ GetBrowsables()

TList * TBranch::GetBrowsables ( )
virtual

Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListOfBrowsables.

Definition at line 1311 of file TBranch.cxx.

◆ GetBulkEntries()

Int_t TBranch::GetBulkEntries ( Long64_t entry,
TBuffer & user_buf )
private

Read a basket of events into the given buffer with byte swapping.

Returns
On success, the number of events of the type held by this branch that have been read into the buffer. -1 on failure.

On success, the caller should be able to access the contents of buf as they are with:

static_cast<T*>(buf.GetCurrent())

where T is the type stored on this branch.

When count_buf points to a valid TBuffer and the branch has a branch count, count_buf will be filled (via a call to GetEntriesSerialized) with the data from the branchCount. After deserialization those value can be used to calculate the number of elements corresponding to each entries.

For each entry the number of elements is the multiplication of

TLeaf *leaf = static_cast<TLeaf*>(branch->GetListOfLeaves()->At(0));
auto len = leaf->GetLen();
A TLeaf describes individual elements of a TBranch See TBranch structure in TTree.
Definition TLeaf.h:57
virtual Int_t GetLen() const
Return the number of effective elements of this leaf, for the current entry.
Definition TLeaf.cxx:405

and the value in the BranchCount corresponding to that entry (can be obtained from branch->GetBranchCount()).

Note
This interface is not meant to be exposed to end users, but rather it should be wrapped by higher-level interfaces.
See TBranch::GetEntriesSerialized() for an alternative that does not perform byte swapping (useful to save one pass over data in some cases).

Definition at line 1471 of file TBranch.cxx.

◆ GetBulkRead()

ROOT::Experimental::Internal::TBulkBranchRead & TBranch::GetBulkRead ( )
inline

Definition at line 227 of file TBranch.h.

◆ GetClassName()

const char * TBranch::GetClassName ( ) const
virtual

Return the name of the user class whose content is stored in this branch, if any.

If this branch was created using the 'leaflist' technique, this function returns an empty string.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, and TBranchSTL.

Definition at line 1323 of file TBranch.cxx.

◆ GetCompressionAlgorithm()

Int_t TBranch::GetCompressionAlgorithm ( ) const
inline

Definition at line 308 of file TBranch.h.

◆ GetCompressionLevel()

Int_t TBranch::GetCompressionLevel ( ) const
inline

Definition at line 314 of file TBranch.h.

◆ GetCompressionSettings()

Int_t TBranch::GetCompressionSettings ( ) const
inline

Definition at line 320 of file TBranch.h.

◆ GetDirectory()

TDirectory * TBranch::GetDirectory ( ) const
inline

Definition at line 233 of file TBranch.h.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEntries()

Long64_t TBranch::GetEntries ( ) const
inline

Definition at line 260 of file TBranch.h.

◆ GetEntriesSerialized() [1/2]

Int_t TBranch::GetEntriesSerialized ( Long64_t N,
TBuffer & user_buf )
inlineprivate

Definition at line 194 of file TBranch.h.

◆ GetEntriesSerialized() [2/2]

Int_t TBranch::GetEntriesSerialized ( Long64_t entry,
TBuffer & user_buf,
TBuffer * count_buf )
private

Read a basket of events into the given buffer without byte swapping.

Returns
On success, the number of events of the type held by this branch that have been read into the buffer. -1 on failure.

On success, the caller still need to deserialize the content. For example for a scalar branch and N the return value (i.e. number of entries)

rawdata = static_cast<char*>(buf.GetCurrent());
for (std::size_t i = 0u; i < N; ++i, ++target)
frombuf(rawdata, target); // `frombuf` also advances the `rawdata` pointer
void frombuf(char *&buf, Bool_t *x)
Definition Bytes.h:270
#define N

where target is a pointer or array to the type stored on this branch.

When count_buf points to a valid TBuffer and the branch has a branch count, count_buf will be filled (via a call to GetEntriesSerialized()) with the data from the branchCount. After deserialization those value can be used to calculate the number of elements corresponding to each entries.

For each entry the number of elements is the multiplication of

TLeaf *leaf = dynamic_cast<TLeaf*>(branch->GetListOfLeaves()->At(0));
auto len = leaf->GetLen();

and the value in the BranchCount corresponding to that entry (can be obtained from branch->GetBranchCount()).

Note
This interface is not meant to be exposed to end users, but rather it should be wrapped by higher-level interfaces.
See TBranch::GetBulkEntries() for an alternative that also performs byte swapping.

Definition at line 1585 of file TBranch.cxx.

◆ GetEntry()

Int_t TBranch::GetEntry ( Long64_t entry = 0,
Int_t getall = 0 )
virtual

Read all leaves of entry and return total number of bytes read.

The input argument "entry" is the entry number in the current tree. In case of a TChain, the entry number in the current Tree must be found before calling this function. For example:

TChain* chain = ...;
Long64_t localEntry = chain->LoadTree(entry);
branch->GetEntry(localEntry);
long long Long64_t
Portable signed long integer 8 bytes.
Definition RtypesCore.h:83
A chain is a collection of files containing TTree objects.
Definition TChain.h:33

The function returns the number of bytes read from the input buffer. If entry does not exist, the function returns 0. If an I/O error occurs, the function returns -1.

See IMPORTANT REMARKS in TTree::GetEntry.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and THbookBranch.

Definition at line 1705 of file TBranch.cxx.

◆ GetEntryExport()

Int_t TBranch::GetEntryExport ( Long64_t entry,
Int_t getall,
TClonesArray * li,
Int_t nentries )
virtual

Read all leaves of an entry and export buffers to real objects in a TClonesArray list.

Returns total number of bytes read.

Definition at line 1761 of file TBranch.cxx.

◆ GetEntryNumber()

Long64_t TBranch::GetEntryNumber ( ) const
inline

Definition at line 251 of file TBranch.h.

◆ GetEntryOffsetLen()

Int_t TBranch::GetEntryOffsetLen ( ) const
inline

Definition at line 236 of file TBranch.h.

◆ GetEvent()

Int_t TBranch::GetEvent ( Long64_t entry = 0)
inline

Definition at line 237 of file TBranch.h.

◆ GetExpectedType()

Int_t TBranch::GetExpectedType ( TClass *& clptr,
EDataType & type )
virtual

Fill expectedClass and expectedType with information on the data type of the object/values contained in this branch (and thus the type of pointers expected to be passed to Set[Branch]Address return 0 in case of success and > 0 in case of failure.

Reimplemented in TBranchElement, TBranchObject, and TBranchSTL.

Definition at line 1833 of file TBranch.cxx.

◆ GetFile()

TFile * TBranch::GetFile ( Int_t mode = 0)
virtual

Return pointer to the file where branch buffers reside, returns 0 in case branch buffers reside in the same file as tree header.

If mode is 1 the branch buffer file is recreated.

Definition at line 1852 of file TBranch.cxx.

◆ GetFileName()

const char * TBranch::GetFileName ( ) const
inline

Definition at line 243 of file TBranch.h.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const
inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const
inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetFirstEntry()

Long64_t TBranch::GetFirstEntry ( ) const
inline

Definition at line 252 of file TBranch.h.

◆ GetFreshBasket()

TBasket * TBranch::GetFreshBasket ( Int_t basketnumber,
TBuffer * user_buffer )
protected

Return a fresh basket by either reusing an existing basket that needs to be drop (according to TTree::MemoryFull) or create a new one.

If the user_buffer argument is non-null, then the memory in the user-provided buffer will be utilized by the underlying basket.

The basket number is used to estimate the required buffer size and try to optimize memory usage and number of memory allocation.

Definition at line 1893 of file TBranch.cxx.

◆ GetFreshCluster()

TBasket * TBranch::GetFreshCluster ( TBuffer * user_buffer)
protected

Drops the cluster two behind the current cluster and returns a fresh basket by either reusing or creating a new one.

Definition at line 1952 of file TBranch.cxx.

◆ GetFullName()

TString TBranch::GetFullName ( ) const
virtual

Return the 'full' name of the branch.

In particular prefix the mother's name when it does not end in a trailing dot and thus is not part of the branch name

Reimplemented in TBranchElement.

Definition at line 2030 of file TBranch.cxx.

◆ GetIconName()

const char * TBranch::GetIconName ( ) const
overridevirtual

Return icon name depending on type of branch.

Reimplemented from TObject.

Reimplemented in TBranchElement.

Definition at line 1331 of file TBranch.cxx.

◆ GetIOFeatures()

ROOT::TIOFeatures TBranch::GetIOFeatures ( ) const

Returns the IO settings currently in use for this branch.

Definition at line 2254 of file TBranch.cxx.

◆ GetLeaf()

TLeaf * TBranch::GetLeaf ( const char * name) const
virtual

Return pointer to the 1st Leaf named name in thisBranch.

Definition at line 2054 of file TBranch.cxx.

◆ GetListOfBaskets()

TObjArray * TBranch::GetListOfBaskets ( )
inline

Definition at line 254 of file TBranch.h.

◆ GetListOfBranches()

TObjArray * TBranch::GetListOfBranches ( )
inline

Definition at line 255 of file TBranch.h.

◆ GetListOfLeaves()

TObjArray * TBranch::GetListOfLeaves ( )
inline

Definition at line 256 of file TBranch.h.

◆ GetMakeClass()

bool TBranch::GetMakeClass ( ) const
virtual

Return whether this branch is in a mode where the object are decomposed or not (Also known as MakeClass mode).

Reimplemented in TBranchElement.

Definition at line 2116 of file TBranch.cxx.

◆ GetMaxBaskets()

Int_t TBranch::GetMaxBaskets ( ) const
inline

Definition at line 257 of file TBranch.h.

◆ GetMother()

TBranch * TBranch::GetMother ( ) const

Get our top-level parent branch in the tree.

Definition at line 2126 of file TBranch.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNleaves()

Int_t TBranch::GetNleaves ( ) const
inline

Definition at line 258 of file TBranch.h.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOffset()

Int_t TBranch::GetOffset ( ) const
inline

Definition at line 244 of file TBranch.h.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetReadBasket()

Int_t TBranch::GetReadBasket ( ) const
inline

Definition at line 245 of file TBranch.h.

◆ GetReadEntry()

Long64_t TBranch::GetReadEntry ( ) const
inline

Definition at line 246 of file TBranch.h.

◆ GetRealFileName()

TString TBranch::GetRealFileName ( ) const
protected

Get real file name.

Definition at line 2067 of file TBranch.cxx.

◆ GetRow()

Int_t TBranch::GetRow ( Int_t row)
virtual

Return all elements of one row unpacked in internal array fValues [Actually just returns 1 (?)].

Definition at line 2107 of file TBranch.cxx.

◆ GetSplitLevel()

Int_t TBranch::GetSplitLevel ( ) const
inline

Definition at line 259 of file TBranch.h.

◆ GetSubBranch()

TBranch * TBranch::GetSubBranch ( const TBranch * child) const

Find the parent branch of child.

Return 0 if child is not in this branch hierarchy.

Definition at line 2163 of file TBranch.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetTotalSize()

Long64_t TBranch::GetTotalSize ( Option_t * option = "") const

Return total number of bytes in the branch (including current buffer).

Definition at line 2200 of file TBranch.cxx.

◆ GetTotBytes()

Long64_t TBranch::GetTotBytes ( Option_t * option = "") const

Return total number of bytes in the branch (excluding current buffer) if option ="*" includes all sub-branches of this branch too.

Definition at line 2219 of file TBranch.cxx.

◆ GetTransientBuffer()

TBuffer * TBranch::GetTransientBuffer ( Int_t size)

Returns the transient buffer currently used by this TBranch for reading/writing baskets.

Definition at line 522 of file TBranch.cxx.

◆ GetTree()

TTree * TBranch::GetTree ( ) const
inline

Definition at line 261 of file TBranch.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetWriteBasket()

Int_t TBranch::GetWriteBasket ( ) const
inline

Definition at line 247 of file TBranch.h.

◆ GetZipBytes()

Long64_t TBranch::GetZipBytes ( Option_t * option = "") const

Return total number of zip bytes in the branch if option ="*" includes all sub-branches of this branch too.

Definition at line 2237 of file TBranch.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Init()

void TBranch::Init ( const char * name,
const char * leaflist,
Int_t compress )
protected

Definition at line 299 of file TBranch.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TBranch::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchRef, TBranchSTL, and THbookBranch.

Definition at line 304 of file TBranch.h.

◆ IsAutoDelete()

bool TBranch::IsAutoDelete ( ) const

Return true if an existing object in a TBranchObject must be deleted.

Definition at line 2262 of file TBranch.cxx.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

bool TBranch::IsFolder ( ) const
overridevirtual

Return true if more than one leaf or browsables, false otherwise.

Reimplemented from TObject.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, and TBranchSTL.

Definition at line 2270 of file TBranch.cxx.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const
inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ KeepCircular()

void TBranch::KeepCircular ( Long64_t maxEntries)
virtual

keep a maximum of fMaxEntries in memory

Definition at line 2282 of file TBranch.cxx.

◆ LoadBaskets()

Int_t TBranch::LoadBaskets ( )
virtual

Baskets associated to this branch are forced to be in memory.

You can call TTree::SetMaxVirtualSize(maxmemory) to instruct the system that the total size of the imported baskets does not exceed maxmemory bytes.

The function returns the number of baskets that have been put in memory. This method may be called to force all baskets of one or more branches in memory when random access to entries in this branch is required. See also TTree::LoadBaskets to load all baskets of all branches in memory.

Definition at line 2308 of file TBranch.cxx.

◆ ls()

void TNamed::ls ( Option_t * option = "") const
overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

Definition at line 1160 of file TObject.cxx.

◆ Modify()

virtual void TAttFill::Modify ( )
virtualinherited

◆ ModifyOn()

virtual void TAttFill::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

void * TObject::operator new[] ( size_t sz,
void * vp )
inlineinherited

Definition at line 192 of file TObject.h.

◆ operator=()

TBranch & TBranch::operator= ( const TBranch & )
privatedelete

◆ Paint()

void TObject::Paint ( Option_t * option = "")
virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TBranch::Print ( Option_t * option = "") const
overridevirtual

Print TBranch parameters.

If options contains "basketsInfo" print the entry number, location and size of each baskets.

Reimplemented from TObject.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchRef, and TBranchSTL.

Definition at line 2340 of file TBranch.cxx.

◆ PrintCacheInfo()

void TBranch::PrintCacheInfo ( ) const

Print the information we have about which basket is currently cached and whether they have been 'used'/'read' from the cache.

Definition at line 2444 of file TBranch.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ ReadBasket()

void TBranch::ReadBasket ( TBuffer & b)
virtual

Loop on all leaves of this branch to read Basket buffer.

Definition at line 2452 of file TBranch.cxx.

◆ ReadLeaves0Impl()

void TBranch::ReadLeaves0Impl ( TBuffer & b)
protected

Read zero leaves without the overhead of a loop.

Definition at line 2471 of file TBranch.cxx.

◆ ReadLeaves1Impl()

void TBranch::ReadLeaves1Impl ( TBuffer & b)
protected

Read one leaf without the overhead of a loop.

Definition at line 2478 of file TBranch.cxx.

◆ ReadLeaves2Impl()

void TBranch::ReadLeaves2Impl ( TBuffer & b)
protected

Read two leaves without the overhead of a loop.

Definition at line 2486 of file TBranch.cxx.

◆ ReadLeavesImpl()

void TBranch::ReadLeavesImpl ( TBuffer & b)
protected

Loop on all leaves of this branch to read Basket buffer.

Definition at line 2460 of file TBranch.cxx.

◆ RecursiveRemove()

◆ Refresh()

void TBranch::Refresh ( TBranch * b)
virtual

Refresh this branch using new information in b This function is called by TTree::Refresh.

Definition at line 2507 of file TBranch.cxx.

◆ Reset()

void TBranch::Reset ( Option_t * option = "")
virtual

Reset a Branch.

  • Existing buffers are deleted.
  • Entries, max and min are reset.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, and TBranchRef.

Definition at line 2556 of file TBranch.cxx.

◆ ResetAddress()

void TBranch::ResetAddress ( )
virtual

Reset the address of the branch.

Reimplemented in TBranchElement.

Definition at line 2650 of file TBranch.cxx.

◆ ResetAfterMerge()

void TBranch::ResetAfterMerge ( TFileMergeInfo * )
virtual

Reset a Branch.

  • Existing buffers are deleted.
  • Entries, max and min are reset.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, and TBranchRef.

Definition at line 2597 of file TBranch.cxx.

◆ ResetAttFill()

virtual void TAttFill::ResetAttFill ( Option_t * option = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ ResetCount()

void TBranch::ResetCount ( )
static

Static function resetting fgCount.

Definition at line 2673 of file TBranch.cxx.

◆ ResetReadEntry()

virtual void TBranch::ResetReadEntry ( )
inlinevirtual

Definition at line 278 of file TBranch.h.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SaveFillAttributes()

virtual void TAttFill::SaveFillAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1001 )
virtualinherited

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SetAddress()

void TBranch::SetAddress ( void * addr)
virtual

Set address of this branch.

See also
TBranchElement::SetAddress
Note
TBranch::SetAddress is a lower level interface and has less ability to check for incorrect setup than TTree::SetBranchAddress. Without TTree::SetMakeClass, if the branch is within an object, the input of SetAddress is expected to be the start of the object (and thus the offset of the data member is added to the provided address). The explicit purpose of TTree::SetMakeClass is to disable this addition of the offset. Note that TTree::SetBranchAddress will detect this case and automatically call SetMakeClass for a data member within a class. For example, the tutorial https://root.cern/doc/master/tree108__tree_8C.html generates a ROOT file with a TTree. To read the temperature values, you need either tree->SetBranchAddress("fTemperature", &temp); or tree->SetMakeClass(1); tree->GetBranch("fTemperature")->SetAddress(&temp);.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and THbookBranch.

Definition at line 2694 of file TBranch.cxx.

◆ SetAddressImpl()

virtual void TBranch::SetAddressImpl ( void * addr,
bool ,
Int_t  )
inlineprotectedvirtual

Reimplemented in TBranchElement.

Definition at line 188 of file TBranch.h.

◆ SetAutoDelete()

void TBranch::SetAutoDelete ( bool autodel = true)
virtual

Set the automatic delete bit.

This bit is used by TBranchObject::ReadBasket to decide if an object referenced by a TBranchObject must be deleted or not before reading a new entry.

If autodel is true, this existing object will be deleted, a new object created by the default constructor, then read from disk by the streamer.

If autodel is false, the existing object is not deleted. Root assumes that the user is taking care of deleting any internal object or array (this can be done in the streamer).

Reimplemented in TBranchObject.

Definition at line 2728 of file TBranch.cxx.

◆ SetBasketSize()

void TBranch::SetBasketSize ( Int_t bufsize)
virtual

Set the basket size The function makes sure that the basket size is greater than fEntryOffsetlen.

Reimplemented in TBranchClones, TBranchElement, and TBranchObject.

Definition at line 2741 of file TBranch.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetBufferAddress()

void TBranch::SetBufferAddress ( TBuffer * buf)
virtual

Set address of this branch directly from a TBuffer to avoid streaming.

Note: We do not take ownership of the buffer.

Definition at line 2757 of file TBranch.cxx.

◆ SetCompressionAlgorithm()

void TBranch::SetCompressionAlgorithm ( Int_t algorithm = ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)

Set compression algorithm.

Definition at line 2775 of file TBranch.cxx.

◆ SetCompressionLevel()

void TBranch::SetCompressionLevel ( Int_t level = ROOT::RCompressionSetting::ELevel::kUseMin)

Set compression level.

Definition at line 2795 of file TBranch.cxx.

◆ SetCompressionSettings()

void TBranch::SetCompressionSettings ( Int_t settings = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)

Set compression settings.

Definition at line 2817 of file TBranch.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEntries()

void TBranch::SetEntries ( Long64_t entries)
virtual

Set the number of entries in this branch.

Reimplemented in THbookBranch.

Definition at line 2850 of file TBranch.cxx.

◆ SetEntryOffsetLen()

void TBranch::SetEntryOffsetLen ( Int_t len,
bool updateSubBranches = false )
virtual

Update the default value for the branch's fEntryOffsetLen if and only if it was already non zero (and the new value is not zero) If updateExisting is true, also update all the existing branches.

Definition at line 2833 of file TBranch.cxx.

◆ SetFile() [1/2]

void TBranch::SetFile ( const char * fname)
virtual

Set file where this branch writes/reads its buffers.

By default the branch buffers reside in the file where the Tree was created. If the file name where the tree was created is an absolute path name or an URL (e.g. root://host/...) and if the fname is not an absolute path name or an URL then the path of the tree file is prepended to fname to make the branch file relative to the tree file. In this case one can move the tree + all branch files to a different location in the file system and still access the branch files. The ROOT file will be connected only when necessary. If called by TBranch::Fill (via TBasket::WriteFile), the file will be created with the option "recreate". If called by TBranch::GetEntry (via TBranch::GetBasket), the file will be opened in read mode. To open a file in "update" mode or with a certain compression level, use TBranch::SetFile(TFile *file).

Definition at line 2920 of file TBranch.cxx.

◆ SetFile() [2/2]

void TBranch::SetFile ( TFile * file = nullptr)
virtual

Set file where this branch writes/reads its buffers.

By default the branch buffers reside in the file where the Tree was created. If the file name where the tree was created is an absolute path name or an URL (e.g. or root://host/...) and if the fname is not an absolute path name or an URL then the path of the tree file is prepended to fname to make the branch file relative to the tree file. In this case one can move the tree + all branch files to a different location in the file system and still access the branch files. The ROOT file will be connected only when necessary. If called by TBranch::Fill (via TBasket::WriteFile), the file will be created with the option "recreate". If called by TBranch::GetEntry (via TBranch::GetBasket), the file will be opened in read mode. To open a file in "update" mode or with a certain compression level, use TBranch::SetFile(TFile *file).

Definition at line 2875 of file TBranch.cxx.

◆ SetFillAttributes()

virtual void TAttFill::SetFillAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor)
inlinevirtualinherited

Set the fill area color.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSpider, TSVG, TTeXDump, and TVirtualX.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber )
inherited

◆ SetFillColorAlpha()

virtual void TAttFill::SetFillColorAlpha ( Color_t fcolor,
Float_t falpha )
virtualinherited

Reimplemented in TGraphMultiErrors.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle)
inlinevirtualinherited

Set the fill area style.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPad, TSpider, and TVirtualX.

Definition at line 42 of file TAttFill.h.

◆ SetFirstEntry()

void TBranch::SetFirstEntry ( Long64_t entry)
virtual

set the first entry number (case of TBranchSTL)

Definition at line 3291 of file TBranch.cxx.

◆ SetIOFeatures()

void TBranch::SetIOFeatures ( TIOFeatures & features)
inline

Definition at line 292 of file TBranch.h.

◆ SetMakeClass()

bool TBranch::SetMakeClass ( bool decomposeObj = true)
virtual

Set the branch in a mode where the object are decomposed (Also known as MakeClass mode).

Return whether the setting was possible (it is not possible for TBranch and TBranchObject).

Reimplemented in TBranchElement.

Definition at line 2939 of file TBranch.cxx.

◆ SetName()

void TNamed::SetName ( const char * name)
virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetObject()

void TBranch::SetObject ( void * objadd)
virtual

Set object this branch is pointing to.

Reimplemented in TBranchElement.

Definition at line 2948 of file TBranch.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetOffset()

virtual void TBranch::SetOffset ( Int_t offset = 0)
inlinevirtual

Reimplemented in TBranchElement.

Definition at line 294 of file TBranch.h.

◆ SetSkipZip()

void TBranch::SetSkipZip ( bool skip = true)
inlineprotected

Definition at line 179 of file TBranch.h.

◆ SetStatus()

void TBranch::SetStatus ( bool status = true)
virtual

Set branch status to Process or DoNotProcess.

Definition at line 2959 of file TBranch.cxx.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetTree()

virtual void TBranch::SetTree ( TTree * tree)
inlinevirtual

Reimplemented in TBranchClones.

Definition at line 296 of file TBranch.h.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetupAddresses()

void TBranch::SetupAddresses ( )
virtual

If the branch address is not set, we set all addresses starting with the top level parent branch.

Reimplemented in TBranchElement, and TBranchObject.

Definition at line 3306 of file TBranch.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TBranch::Streamer ( TBuffer & b)
overridevirtual

Stream a class object.

Reimplemented from TObject.

Reimplemented in TBranchClones, TBranchElement, TBranchObject, TBranchRef, TBranchSTL, and THbookBranch.

Definition at line 2968 of file TBranch.cxx.

◆ StreamerNVirtual()

void TBranch::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 304 of file TBranch.h.

◆ SupportsBulkRead()

bool TBranch::SupportsBulkRead ( ) const

Returns true if this branch supports bulk IO, false otherwise.

This will return true if all the various preconditions necessary hold true to perform bulk IO (reasonable type, single TLeaf, etc); the bulk IO may still fail, depending on the contents of the individual TBaskets loaded.

Definition at line 1430 of file TBranch.cxx.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ UpdateAddress()

virtual void TBranch::UpdateAddress ( )
inlinevirtual

Reimplemented in TBranchObject.

Definition at line 299 of file TBranch.h.

◆ UpdateFile()

void TBranch::UpdateFile ( )
virtual

Refresh the value of fDirectory (i.e.

where this branch writes/reads its buffers) with the current value of fTree->GetCurrentFile unless this branch has been redirected to a different file. Also update the sub-branches.

Reimplemented in TBranchClones, and TBranchElement.

Definition at line 3316 of file TBranch.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

◆ WriteBasket()

Int_t TBranch::WriteBasket ( TBasket * basket,
Int_t where )
inlineprotected

Definition at line 184 of file TBranch.h.

◆ WriteBasketImpl()

Int_t TBranch::WriteBasketImpl ( TBasket * basket,
Int_t where,
ROOT::Internal::TBranchIMTHelper * imtHelper )
private

Write the current basket to disk and return the number of bytes written to the file.

Definition at line 3214 of file TBranch.cxx.

◆ ROOT::Experimental::Internal::TBulkBranchRead

Definition at line 102 of file TBranch.h.

◆ TBranchElement

friend class TBranchElement
friend

Definition at line 101 of file TBranch.h.

◆ TTree

friend class TTree
friend

Definition at line 100 of file TBranch.h.

◆ TTreeCache

friend class TTreeCache
friend

Definition at line 98 of file TBranch.h.

◆ TTreeCloner

friend class TTreeCloner
friend

Definition at line 99 of file TBranch.h.

Member Data Documentation

◆ fAddress

char* TBranch::fAddress
protected

! Address of 1st leaf (variable or object)

Definition at line 156 of file TBranch.h.

◆ fBasketBytes

Int_t* TBranch::fBasketBytes
protected

[fMaxBaskets] Length of baskets on file

Definition at line 150 of file TBranch.h.

◆ fBasketEntry

Long64_t* TBranch::fBasketEntry
protected

[fMaxBaskets] Table of first entry in each basket

Definition at line 151 of file TBranch.h.

◆ fBaskets

TObjArray TBranch::fBaskets
protected

-> List of baskets of this branch

Definition at line 149 of file TBranch.h.

◆ fBasketSeek

Long64_t* TBranch::fBasketSeek
protected

[fMaxBaskets] Addresses of baskets on file

Definition at line 152 of file TBranch.h.

◆ fBasketSize

Int_t TBranch::fBasketSize
protected

Initial Size of Basket Buffer.

Definition at line 127 of file TBranch.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBranches

TObjArray TBranch::fBranches
protected

-> List of Branches of this branch

Definition at line 147 of file TBranch.h.

◆ fBrowsables

TList* TBranch::fBrowsables
protected

! List of TVirtualBranchBrowsables used for Browse()

Definition at line 161 of file TBranch.h.

◆ fBulk

BulkObj TBranch::fBulk
protected

! Helper for performing bulk IO

Definition at line 162 of file TBranch.h.

◆ fCacheInfo

CacheInfo_t TBranch::fCacheInfo
protected

! Hold info about which basket are in the cache and if they have been retrieved from the cache.

Definition at line 167 of file TBranch.h.

◆ fCompress

Int_t TBranch::fCompress
protected

Compression level and algorithm.

Definition at line 126 of file TBranch.h.

◆ fCurrentBasket

TBasket* TBranch::fCurrentBasket
protected

! Pointer to the current basket.

Definition at line 142 of file TBranch.h.

◆ fDirectory

TDirectory* TBranch::fDirectory
protected

! Pointer to directory where this branch buffers are stored

Definition at line 157 of file TBranch.h.

◆ fEntries

Long64_t TBranch::fEntries
protected

Number of entries.

Definition at line 143 of file TBranch.h.

◆ fEntryBuffer

TBuffer* TBranch::fEntryBuffer
protected

! Buffer used to directly pass the content without streaming

Definition at line 159 of file TBranch.h.

◆ fEntryNumber

Long64_t TBranch::fEntryNumber
protected

Current entry number (last one filled in this branch).

Definition at line 130 of file TBranch.h.

◆ fEntryOffsetLen

Int_t TBranch::fEntryOffsetLen
protected

Initial Length of fEntryOffset table in the basket buffers.

Definition at line 128 of file TBranch.h.

◆ fExtraBasket

TBasket* TBranch::fExtraBasket
protected

! Allocated basket not currently holding any data.

Definition at line 131 of file TBranch.h.

◆ fFileName

TString TBranch::fFileName
protected

Name of file where buffers are stored ("" if in same file as Tree header).

Definition at line 158 of file TBranch.h.

◆ fFillColor

Color_t TAttFill::fFillColor
protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillLeaves

FillLeaves_t TBranch::fFillLeaves
protected

! Pointer to the FillLeaves implementation to use.

Definition at line 172 of file TBranch.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle
protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fFirstBasketEntry

Long64_t TBranch::fFirstBasketEntry
protected

! First entry in the current basket.

Definition at line 140 of file TBranch.h.

◆ fFirstEntry

Long64_t TBranch::fFirstEntry
protected

Number of the first entry in this branch.

Definition at line 144 of file TBranch.h.

◆ fgCount

Int_t TBranch::fgCount = 0
staticprotected

! branch counter

Definition at line 125 of file TBranch.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fIOFeatures

TIOFeatures TBranch::fIOFeatures
protected

IO features for newly-created baskets.

Definition at line 132 of file TBranch.h.

◆ fLeaves

TObjArray TBranch::fLeaves
protected

-> List of leaves of this branch

Definition at line 148 of file TBranch.h.

◆ fMaxBaskets

Int_t TBranch::fMaxBaskets
protected

Maximum number of Baskets so far.

Definition at line 134 of file TBranch.h.

◆ fMother

TBranch* TBranch::fMother
protected

! Pointer to top-level parent branch in the tree.

Definition at line 154 of file TBranch.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNBaskets

Int_t TBranch::fNBaskets
protected

! Number of baskets in memory

Definition at line 135 of file TBranch.h.

◆ fNextBasketEntry

Long64_t TBranch::fNextBasketEntry
protected

! Next entry that will requires us to go to the next basket

Definition at line 141 of file TBranch.h.

◆ fNleaves

Int_t TBranch::fNleaves
protected

! Number of leaves

Definition at line 137 of file TBranch.h.

◆ fOffset

Int_t TBranch::fOffset
protected

Offset of this branch.

Definition at line 133 of file TBranch.h.

◆ fParent

TBranch* TBranch::fParent
protected

! Pointer to parent branch.

Definition at line 155 of file TBranch.h.

◆ fReadBasket

Int_t TBranch::fReadBasket
protected

! Current basket number when reading

Definition at line 138 of file TBranch.h.

◆ fReadEntry

Long64_t TBranch::fReadEntry
protected

! Current entry number when reading

Definition at line 139 of file TBranch.h.

◆ fReadLeaves

ReadLeaves_t TBranch::fReadLeaves
protected

! Pointer to the ReadLeaves implementation to use.

Definition at line 170 of file TBranch.h.

◆ fSkipZip

bool TBranch::fSkipZip
protected

! After being read, the buffer will not be unzipped.

Definition at line 164 of file TBranch.h.

◆ fSplitLevel

Int_t TBranch::fSplitLevel
protected

Branch split level.

Definition at line 136 of file TBranch.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fTotBytes

Long64_t TBranch::fTotBytes
protected

Total number of bytes in all leaves before compression.

Definition at line 145 of file TBranch.h.

◆ fTransientBuffer

TBuffer* TBranch::fTransientBuffer
protected

! Pointer to the current transient buffer.

Definition at line 160 of file TBranch.h.

◆ fTree

TTree* TBranch::fTree
protected

! Pointer to Tree header

Definition at line 153 of file TBranch.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fWriteBasket

Int_t TBranch::fWriteBasket
protected

Last basket number written.

Definition at line 129 of file TBranch.h.

◆ fZipBytes

Long64_t TBranch::fZipBytes
protected

Total number of bytes in all leaves after compression.

Definition at line 146 of file TBranch.h.


The documentation for this class was generated from the following files: