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

A TTreeCache which exploits parallelized decompression of its own content.

Definition at line 35 of file TTreeCacheUnzip.h.

Classes

struct  UnzipState

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)) }
enum  EParUnzipMode { kEnable , kDisable , kForce }
enum  EPrefillType { kNoPrefill , kAllBranches }
enum  EStatusBits {
  kCanDelete = (1ULL << (0)) , kMustCleanup = (1ULL << (3)) , kIsReferenced = (1ULL << (4)) , kHasUUID = (1ULL << (5)) ,
  kCannotPick = (1ULL << (6)) , kNoContextMenu = (1ULL << (8)) , kInvalidObject = (1ULL << (13))
}
enum  EUnzipState { kUntouched , kProgress , kFinished }

Public Member Functions

 TTreeCacheUnzip ()
 TTreeCacheUnzip (TTree *tree, Int_t buffersize=0)
 Constructor.
 ~TTreeCacheUnzip () override
 Destructor. (in general called by the TFile 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.
Int_t AddBranch (const char *branch, bool subbranches=false) override
 Add a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket Returns:
Int_t AddBranch (TBranch *b, bool subbranches=false) override
 Add a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket Returns:
virtual void AddNoCacheBytesRead (Long64_t len)
virtual void AddNoCacheReadCalls (Int_t reads)
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
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.
virtual void Clear (Option_t *="")
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
virtual void Close (Option_t *option="")
 Close out any threads or asynchronous fetches used by the underlying implementation.
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
virtual void Copy (TObject &object) const
 Copy this to obj.
Int_t CreateTasks ()
 We create a TTaskGroup and asynchronously maps each group of baskets(> 100 kB in total) to a task.
virtual void Delete (Option_t *option="")
 Delete this object.
virtual void Disable ()
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 Int_t DropBranch (const char *branch, bool subbranches=false)
 Remove a branch to the list of branches to be stored in the cache this is to be used by user (thats why we pass the name of the branch).
virtual Int_t DropBranch (TBranch *b, bool subbranches=false)
 Remove a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket.
virtual void Dump () const
 Dump contents of object on stdout.
virtual void Enable ()
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).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
bool FillBuffer () override
 Fill the cache buffer with the branches in the cache.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
virtual Int_t GetBufferSize () const
virtual Long64_t GetBytesRead () const
virtual Long64_t GetBytesReadExtra () const
const TObjArrayGetCachedBranches () const
EPrefillType GetConfiguredPrefillType () const
 Return the desired prefill type from the environment or resource variable.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
Double_t GetEfficiency () const
 Give the total efficiency of the primary cache... defined as the ratio of blocks found in the cache vs.
Double_t GetEfficiencyRel () const
 This will indicate a sort of relative efficiency... a ratio of the reads found in the cache to the number of reads so far.
virtual Int_t GetEntryMax () const
virtual Int_t GetEntryMin () const
TFileGetFile () const
virtual const char * GetIconName () const
 Returns mime type name of object.
virtual EPrefillType GetLearnPrefill () const
Double_t GetMissEfficiency () const
 The total efficiency of the 'miss cache' - defined as the ratio of blocks found in the cache versus the number of blocks prefetched.
Double_t GetMissEfficiencyRel () const
 Relative efficiency of the 'miss cache' - ratio of the reads found in cache to the number of reads so far.
virtual const char * GetName () const
 Returns name of object.
Int_t GetNFound ()
Int_t GetNMissed ()
virtual Long64_t GetNoCacheBytesRead () const
virtual Int_t GetNoCacheReadCalls () const
Int_t GetNseek () const
Int_t GetNtot () const
Int_t GetNUnzip ()
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
bool GetOptimizeMisses () const
virtual Option_tGetOption () const
Long64_t GetPrefetchedBlocks () const
virtual TFilePrefetchGetPrefetchObj ()
virtual Int_t GetReadCalls () const
Int_t GetRecordHeader (char *buf, Int_t maxbytes, Int_t &nbytes, Int_t &objlen, Int_t &keylen)
 Read the logical record header from the buffer buf.
virtual const char * GetTitle () const
 Returns title of object.
TTreeGetTree () const
virtual UInt_t GetUniqueID () const
 Return the unique object id.
Int_t GetUnzipBuffer (char **buf, Long64_t pos, Int_t len, bool *free) override
 We try to read a buffer that has already been unzipped Returns -1 in case of read failure, 0 in case it's not in the cache and n>0 in case read from cache (number of bytes copied).
Int_t GetUnzipGroupSize ()
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
virtual ULong_t Hash () const
 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
virtual Bool_t IsAsyncReading () const
bool IsAutoCreated () const
Bool_t IsDestructed () const
 IsDestructed.
virtual bool IsEnabled () const
virtual Bool_t IsEnablePrefetching () const
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
bool IsLearning () const override
Bool_t IsOnHeap () const
virtual Bool_t IsSortable () const
Bool_t IsZombie () const
Int_t LearnBranch (TBranch *b, bool subgbranches=false) override
 Add a branch discovered by actual usage to the list of branches to be stored in the cache this function is called by TBranch::GetBasket If we are not longer in the training phase this is an error.
virtual void LearnPrefill ()
 Perform an initial prefetch, attempting to read as much of the learning phase baskets for all branches at once.
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
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 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.
virtual void Prefetch (Long64_t pos, Int_t len)
 Add block of length len at position pos in the list of blocks to be prefetched.
void Print (Option_t *option="") const override
 Print cache statistics.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
Int_t ReadBuffer (char *buf, Long64_t pos, Int_t len) override
 Read buffer at position pos if the request is in the list of prefetched blocks read from fBuffer.
Int_t ReadBufferExt (char *buf, Long64_t pos, Int_t len, Int_t &loc) override
virtual Int_t ReadBufferExtNormal (char *buf, Long64_t pos, Int_t len, Int_t &loc)
 Base function for ReadBuffer.
virtual Int_t ReadBufferExtPrefetch (char *buf, Long64_t pos, Int_t len, Int_t &loc)
 prefetch the first block
virtual Int_t ReadBufferNormal (char *buf, Long64_t pos, Int_t len)
 Old method ReadBuffer before the addition of the prefetch mechanism.
virtual Int_t ReadBufferPrefetch (char *buf, Long64_t pos, Int_t len)
 Used to read a chunk from a block previously fetched.
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
void ResetBit (UInt_t f)
void ResetCache () override
 This will delete the list of buffers that are in the unzipping cache and will reset certain values in the cache.
void ResetMissCache ()
 Reset all the miss cache training.
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
virtual void SecondPrefetch (Long64_t, Int_t)
virtual void SecondSort ()
 Sort buffers to be prefetched in increasing order of positions.
void SetAutoCreated (bool val)
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
Int_t SetBufferSize (Long64_t buffersize) override
 Change the underlying buffer size of the cache.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
virtual void SetEnablePrefetching (Bool_t setPrefetching=kFALSE)
 Set the prefetching mode of this file.
void SetEntryRange (Long64_t emin, Long64_t emax) override
 Set the minimum and maximum entry number to be processed this information helps to optimize the number of baskets to read when prefetching the branch buffers.
void SetFile (TFile *file, TFile::ECacheAction action=TFile::kDisconnect) override
 Change the file that is being cached.
virtual void SetLearnPrefill (EPrefillType type=kNoPrefill)
 Set whether the learning period is started with a prefilling of the cache and which type of prefilling is used.
void SetOptimizeMisses (bool opt)
 Start of methods for the miss cache.
virtual void SetSkipZip (Bool_t=kTRUE)
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void SetUnzipBufferSize (Long64_t bufferSize)
 Sets the size for the unzipping cache... by default it should be two times the size of the prefetching cache.
void SetUnzipGroupSize (Int_t groupSize)
virtual void Sort ()
 Sort buffers to be prefetched in increasing order of positions.
void StartLearningPhase ()
 The name should be enough to explain the method.
void StopLearningPhase () override
 It's the same as TTreeCache::StopLearningPhase but we guarantee that we start the unzipping just after getting the buffers.
void Streamer (TBuffer &) override
 Stream an object of class TObject.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
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
Int_t UnzipBuffer (char **dest, char *src)
 Unzips a ROOT specific buffer... by reading the header at the beginning.
Int_t UnzipCache (Int_t index)
 This inflates a basket in the cache.
void UpdateBranches (TTree *tree) override
 update pointer to current Tree and recompute pointers to the branches in the cache
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 WaitFinishPrefetch ()
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 Int_t GetLearnEntries ()
 Static function returning the number of entries used to train the cache see SetLearnEntries.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static EParUnzipMode GetParallelUnzip ()
 Static function that returns the parallel option (to indicate an additional thread).
static bool IsParallelUnzip ()
 Static function that tells wether the multithreading unzipping is activated.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetLearnEntries (Int_t n=10)
 Static function to set the number of entries to be used in learning mode The default value for n is 10.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
static Int_t SetParallelUnzip (TTreeCacheUnzip::EParUnzipMode option=TTreeCacheUnzip::kEnable)
 Static function that (de)activates multithreading unzipping.
static void SetUnzipRelBufferSize (Float_t relbufferSize)
 static function: Sets the unzip relative buffer size

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }
typedef struct UnzipState UnzipState_t

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void MakeZombie ()
void SetEnablePrefetchingImpl (Bool_t setPrefetching=kFALSE)
 TFileCacheRead implementation of SetEnablePrefetching.

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

bool fAsyncReading
bool fAutoCreated {false}
 ! true if cache was automatically created
Bool_t fBIsSorted
Bool_t fBIsTransferred
Int_tfBLen
 [fBNb]
Int_t fBNb
Int_t fBNseek
Int_t fBNtot
Long64_tfBPos
 [fBNb]
TObjArrayfBranches {nullptr}
 ! List of branches to be stored in the cache
TListfBrNames {nullptr}
 ! list of branch names in the cache
Long64_tfBSeek
 [fBNseek]
Int_tfBSeekIndex
 [fBNseek]
Int_tfBSeekLen
 [fBNseek]
Int_tfBSeekPos
 [fBNseek]
Int_t fBSeekSize
Long64_tfBSeekSort
 [fBNseek]
Int_tfBSeekSortLen
 [fBNseek]
char * fBuffer
 [fBufferSize] buffer of contiguous prefetched blocks
Int_t fBufferLen
 Current buffer length (<= fBufferSize).
Int_t fBufferSize
 Allocated size of fBuffer (at a given time).
Int_t fBufferSizeMin
 Original size of fBuffer.
Long64_t fBytesRead
 Number of bytes read for this cache.
Long64_t fBytesReadExtra
 Number of extra bytes (overhead) read by the readahead buffer.
Long64_t fCurrentClusterStart {-1}
 ! Start of the cluster(s) where the current content was picked out
Int_t fCycle
bool fEmpty
bool fEnabled {true}
 ! cache enabled for cached reading
Bool_t fEnablePrefetching
 reading by prefetching asynchronously
Long64_t fEntryCurrent {-1}
 ! current lowest entry number in the cache
Long64_t fEntryMax {1}
 ! last entry in the cache
Long64_t fEntryMin {0}
 ! first entry in the cache
Long64_t fEntryNext {-1}
 ! next entry number where cache must be filled
TFilefFile
 Pointer to file.
Int_t fFillTimes {0}
 ! how many times we can fill the current buffer
bool fFirstBuffer {true}
 ! true if first buffer is used for prefetching
Long64_t fFirstEntry {-1}
 ! save the value of the first entry
Long64_t fFirstMiss {-1}
 ! set to the event # of the first miss.
bool fFirstTime {true}
 ! save the fact that we processes the first entry
std::unique_ptr< TMutexfIOMutex
bool fIsLearning {true}
 ! true if cache is in learning mode
bool fIsManual {false}
 ! true if cache is StopLearningPhase was used
Bool_t fIsSorted
 True if fSeek array is sorted.
Bool_t fIsTransferred
 True when fBuffer contains something valid.
Long64_t fLastMiss {-1}
 ! set to the event # of the last miss.
bool fLearnPrefilling {false}
 ! true if we are in the process of executing LearnPrefill
Int_tfLen
 [fNb] Length of long buffers
std::unique_ptr< MissCachefMissCache
 ! Cache contents for misses
Int_t fNb
 Number of long buffers.
Int_t fNbranches {0}
 ! Number of branches in the cache
Long64_t fNextClusterStart {-1}
 ! End+1 of the cluster(s) where the current content was picked out
Int_t fNFound
 ! number of blocks that were found in the cache
Int_t fNMissed
 ! number of blocks that were not found in the cache and were unzipped
Int_t fNMissReadMiss {0}
 Number of blocks read and not found in either cache.
Int_t fNMissReadOk {0}
 Number of blocks read, not found in the primary cache, and found in the secondary cache.
Int_t fNMissReadPref {0}
 Number of blocks read into the secondary ("miss") cache.
Long64_t fNoCacheBytesRead
 Number of bytes read by basket to fill cached tree.
Int_t fNoCacheReadCalls
 Number of read calls by basket to fill cached tree.
Int_t fNReadMiss {0}
 Number of blocks read and not found in the cache.
Int_t fNReadOk {0}
 Number of blocks read and found in the cache.
Int_t fNReadPref {0}
 Number of blocks that were prefetched.
Int_t fNseek
 Number of blocks to be prefetched.
Int_t fNseekMax
 ! fNseek can change so we need to know its max size
Int_t fNStalls
 ! number of hits which caused a stall
Int_t fNtot
 Total size of prefetched blocks.
Int_t fNUnzip
 ! number of blocks that were unzipped
bool fOneTime {false}
 ! used in the learning phase
bool fOptimizeMisses {false}
 ! true if we should optimize cache misses.
bool fParallel
 Indicate if we want to activate the parallelism (for this instance).
Long64_tfPos
 [fNb] start of long buffers
TFilePrefetchfPrefetch
 ! Object that does the asynchronous reading in another thread
Long64_t fPrefetchedBlocks
 Number of blocks prefetched.
EPrefillType fPrefillType
 Whether a pre-filling is enabled (and if applicable which type).
Int_t fReadCalls
 Number of read calls for this cache.
bool fReadDirectionSet {false}
 ! read direction established
bool fReverseRead {false}
 ! reading in reverse mode
Long64_tfSeek
 [fNseek] Position on file of buffers to be prefetched
Int_tfSeekIndex
 [fNseek] sorted index table of fSeek
Int_tfSeekLen
 [fNseek] Length of buffers to be prefetched
Int_tfSeekPos
 [fNseek] Position of sorted blocks in fBuffer
Int_t fSeekSize
 Allocated size of fSeek.
Long64_tfSeekSort
 [fNseek] Position on file of buffers to be prefetched (sorted)
Int_tfSeekSortLen
 [fNseek] Length of buffers to be prefetched (sorted)
TTreefTree {nullptr}
 ! pointer to the current Tree
Long64_t fUnzipBufferSize
 ! Max Size for the ready unzipped blocks (default is 2*fBufferSize)
Int_t fUnzipGroupSize
 ! Min accumulated size of a group of baskets ready to be unzipped by a IMT task
UnzipState_t fUnzipState
std::unique_ptr< ROOT::Experimental::TTaskGroupfUnzipTaskGroup

Static Protected Attributes

static Int_t fgLearnEntries = 100
 number of entries used for learning mode
static TTreeCacheUnzip::EParUnzipMode fgParallel = TTreeCacheUnzip::kDisable
 Indicate if we want to activate the parallelism.
static Double_t fgRelBuffSize = .5
 This is the percentage of the TTreeCacheUnzip that will be used.

Private Member Functions

 TTreeCacheUnzip (const TTreeCacheUnzip &)=delete
bool CalculateMissCache ()
 Calculate the appropriate miss cache to fetch; helper function for FillMissCache.
TBranchCalculateMissEntries (Long64_t, int, bool)
 Given an file read, try to determine the corresponding branch.
bool CheckMissCache (char *buf, Long64_t pos, int len)
 Check the miss cache for a particular buffer, fetching if deemed necessary.
bool FillMissCache ()
 Fill the miss cache from the current set of active branches.
IOPos FindBranchBasketPos (TBranch &, Long64_t entry)
 Given a branch and an entry, determine the file location (offset / size) of the corresponding basket.
void Init ()
 Initialization procedure common to all the constructors.
TTreeCacheUnzipoperator= (const TTreeCacheUnzip &)=delete
bool ProcessMiss (Long64_t pos, int len)
 ! Given a file read not in the miss cache, handle (possibly) loading the data.

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
char * fCompBuffer
Int_t fCompBufferSize
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

#include <TTreeCacheUnzip.h>

Inheritance diagram for TTreeCacheUnzip:
TTreeCache TFileCacheRead TObject

Member Typedef Documentation

◆ UnzipState_t

typedef struct UnzipState TTreeCacheUnzip::UnzipState_t
protected

Definition at line 77 of file TTreeCacheUnzip.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.

◆ EParUnzipMode

Enumerator
kEnable 
kDisable 
kForce 

Definition at line 40 of file TTreeCacheUnzip.h.

◆ EPrefillType

enum TTreeCache::EPrefillType
inherited
Enumerator
kNoPrefill 
kAllBranches 

Definition at line 35 of file TTreeCache.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

◆ EUnzipState

Enumerator
kUntouched 
kProgress 
kFinished 

Definition at line 43 of file TTreeCacheUnzip.h.

Constructor & Destructor Documentation

◆ TTreeCacheUnzip() [1/3]

TTreeCacheUnzip::TTreeCacheUnzip ( const TTreeCacheUnzip & )
privatedelete

◆ TTreeCacheUnzip() [2/3]

TTreeCacheUnzip::TTreeCacheUnzip ( )

Definition at line 156 of file TTreeCacheUnzip.cxx.

◆ TTreeCacheUnzip() [3/3]

TTreeCacheUnzip::TTreeCacheUnzip ( TTree * tree,
Int_t buffersize = 0 )

Constructor.

Definition at line 175 of file TTreeCacheUnzip.cxx.

◆ ~TTreeCacheUnzip()

TTreeCacheUnzip::~TTreeCacheUnzip ( )
override

Destructor. (in general called by the TFile destructor).

Definition at line 232 of file TTreeCacheUnzip.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.

◆ AddBranch() [1/2]

Int_t TTreeCacheUnzip::AddBranch ( const char * branch,
bool subbranches = false )
overridevirtual

Add a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket Returns:

  • 0 branch added or already included
  • -1 on error

Reimplemented from TTreeCache.

Definition at line 257 of file TTreeCacheUnzip.cxx.

◆ AddBranch() [2/2]

Int_t TTreeCacheUnzip::AddBranch ( TBranch * b,
bool subbranches = false )
overridevirtual

Add a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket Returns:

  • 0 branch added or already included
  • -1 on error

Reimplemented from TTreeCache.

Definition at line 245 of file TTreeCacheUnzip.cxx.

◆ AddNoCacheBytesRead()

virtual void TFileCacheRead::AddNoCacheBytesRead ( Long64_t len)
inlinevirtualinherited

Definition at line 85 of file TFileCacheRead.h.

◆ AddNoCacheReadCalls()

virtual void TFileCacheRead::AddNoCacheReadCalls ( Int_t reads)
inlinevirtualinherited

Definition at line 86 of file TFileCacheRead.h.

◆ 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.

◆ Browse()

◆ CalculateMissCache()

bool TTreeCache::CalculateMissCache ( )
privateinherited

Calculate the appropriate miss cache to fetch; helper function for FillMissCache.

◆ CalculateMissEntries()

TBranch * TTreeCache::CalculateMissEntries ( Long64_t pos,
int len,
bool all )
privateinherited

Given an file read, try to determine the corresponding branch.

Given a particular IO description (offset / length) representing a 'miss' of the TTreeCache's primary cache, calculate all the corresponding IO that should be performed.

all indicates that this function should search the set of all branches in this TTree. When set to false, we only search through branches that have previously incurred a miss.

Returns:

  • TBranch pointer corresponding to the basket that will be retrieved by this IO operation.
  • If no corresponding branch could be found (or an error occurs), this returns nullptr.

Definition at line 789 of file TTreeCache.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.

◆ CheckMissCache()

bool TTreeCache::CheckMissCache ( char * buf,
Long64_t pos,
int len )
privateinherited

Check the miss cache for a particular buffer, fetching if deemed necessary.

Given an IO operation (pos, len) that was a cache miss in the primary TTC, try the operation again with the miss cache.

Returns true if the IO operation was successful and the contents of buf were populated with the requested data.

Definition at line 920 of file TTreeCache.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 159 of file TTreeCacheUnzip.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()

◆ Clone()

TObject * TObject::Clone ( const char * newname = "") const
virtualinherited

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsStudy, RooCatType, RooCmdArg, RooDataHist, RooDataSet, RooFitResult, RooLinkedList, RooStats::HypoTestResult, RooStats::ModelConfig, RooStudyPackage, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, RooWorkspace, TASImage, TChainIndex, TClass, TCollection, TF1, TFunction, TFunctionTemplate, TH1, TImage, TMethod, TMethodCall, TMinuit, TMVA::MinuitWrapper, TNamed, TStreamerInfo, and TTreeIndex.

Definition at line 243 of file TObject.cxx.

◆ Close()

void TFileCacheRead::Close ( Option_t * option = "")
virtualinherited

Close out any threads or asynchronous fetches used by the underlying implementation.

This is called by TFile::Close to prevent usage of the file handles after the closing of the file.

Definition at line 188 of file TFileCacheRead.cxx.

◆ Compare()

Int_t TObject::Compare ( const TObject * obj) const
virtualinherited

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented in RooAbsArg, RooDouble, TCollection, TEnvRec, TFileInfo, TGeoBranchArray, TGeoOverlap, TGFSFrameElement, TGLBFrameElement, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TStructNode, TStructNodeProperty, and TUrl.

Definition at line 258 of file TObject.cxx.

◆ Copy()

◆ CreateTasks()

Int_t TTreeCacheUnzip::CreateTasks ( )

We create a TTaskGroup and asynchronously maps each group of baskets(> 100 kB in total) to a task.

In TTaskGroup, we use TThreadExecutor to do the actually work of unzipping a group of basket. The purpose of creating TTaskGroup is to avoid competing with main thread.

Definition at line 611 of file TTreeCacheUnzip.cxx.

◆ DeclFileName()

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

Definition at line 159 of file TTreeCacheUnzip.h.

◆ Delete()

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

◆ Disable()

virtual void TTreeCache::Disable ( )
inlinevirtualinherited

Definition at line 136 of file TTreeCache.h.

◆ 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.

◆ DropBranch() [1/2]

Int_t TTreeCache::DropBranch ( const char * bname,
bool subbranches = false )
virtualinherited

Remove a branch to the list of branches to be stored in the cache this is to be used by user (thats why we pass the name of the branch).

It works in exactly the same way as TTree::SetBranchStatus so you probably want to look over there for details about the use of bname with regular expressions. The branches are taken with respect to the Owner of this TTreeCache (i.e. the original Tree) NB: if bname="*" all branches are put in the cache and the learning phase stopped Returns:

  • 0 branch dropped or not in cache
  • -1 on error

Definition at line 585 of file TTreeCache.cxx.

◆ DropBranch() [2/2]

Int_t TTreeCache::DropBranch ( TBranch * b,
bool subbranches = false )
virtualinherited

Remove a branch to the list of branches to be stored in the cache this function is called by TBranch::GetBasket.

Returns:

  • 0 branch dropped or not in cache
  • -1 on error

Definition at line 540 of file TTreeCache.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)
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.

◆ Enable()

virtual void TTreeCache::Enable ( )
inlinevirtualinherited

Definition at line 137 of file TTreeCache.h.

◆ 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()

◆ 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.

◆ FillBuffer()

bool TTreeCacheUnzip::FillBuffer ( )
overridevirtual

Fill the cache buffer with the branches in the cache.

Reimplemented from TTreeCache.

Definition at line 264 of file TTreeCacheUnzip.cxx.

◆ FillMissCache()

bool TTreeCache::FillMissCache ( )
privateinherited

Fill the miss cache from the current set of active branches.

◆ FindBranchBasketPos()

TTreeCache::IOPos TTreeCache::FindBranchBasketPos ( TBranch & b,
Long64_t entry )
privateinherited

Given a branch and an entry, determine the file location (offset / size) of the corresponding basket.

For the event currently being fetched into the miss cache, find the IO (offset / length tuple) to pull in the current basket for a given branch.

Returns:

  • IOPos describing the IO operation necessary for the basket on this branch
  • On failure, IOPos.length will be set to 0.

Definition at line 715 of file TTreeCache.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.

◆ GetBufferSize()

virtual Int_t TFileCacheRead::GetBufferSize ( ) const
inlinevirtualinherited

Definition at line 88 of file TFileCacheRead.h.

◆ GetBytesRead()

virtual Long64_t TFileCacheRead::GetBytesRead ( ) const
inlinevirtualinherited

Definition at line 89 of file TFileCacheRead.h.

◆ GetBytesReadExtra()

virtual Long64_t TFileCacheRead::GetBytesReadExtra ( ) const
inlinevirtualinherited

Definition at line 91 of file TFileCacheRead.h.

◆ GetCachedBranches()

const TObjArray * TTreeCache::GetCachedBranches ( ) const
inlineinherited

Definition at line 139 of file TTreeCache.h.

◆ GetConfiguredPrefillType()

TTreeCache::EPrefillType TTreeCache::GetConfiguredPrefillType ( ) const
inherited

Return the desired prefill type from the environment or resource variable.

  • 0 - No prefill
  • 1 - All branches

Definition at line 1801 of file TTreeCache.cxx.

◆ 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.

◆ GetEfficiency()

Double_t TTreeCache::GetEfficiency ( ) const
inherited

Give the total efficiency of the primary cache... defined as the ratio of blocks found in the cache vs.

the number of blocks prefetched ( it could be more than 1 if we read the same block from the cache more than once )

Note: This should eb used at the end of the processing or we will get incomplete stats

Definition at line 1824 of file TTreeCache.cxx.

◆ GetEfficiencyRel()

Double_t TTreeCache::GetEfficiencyRel ( ) const
inherited

This will indicate a sort of relative efficiency... a ratio of the reads found in the cache to the number of reads so far.

Definition at line 1848 of file TTreeCache.cxx.

◆ GetEntryMax()

virtual Int_t TTreeCache::GetEntryMax ( ) const
inlinevirtualinherited

Definition at line 144 of file TTreeCache.h.

◆ GetEntryMin()

virtual Int_t TTreeCache::GetEntryMin ( ) const
inlinevirtualinherited

Definition at line 143 of file TTreeCache.h.

◆ GetFile()

TFile * TFileCacheRead::GetFile ( ) const
inlineinherited

Definition at line 92 of file TFileCacheRead.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetLearnEntries()

Int_t TTreeCache::GetLearnEntries ( )
staticinherited

Static function returning the number of entries used to train the cache see SetLearnEntries.

Definition at line 1873 of file TTreeCache.cxx.

◆ GetLearnPrefill()

virtual EPrefillType TTreeCache::GetLearnPrefill ( ) const
inlinevirtualinherited

Definition at line 146 of file TTreeCache.h.

◆ GetMissEfficiency()

Double_t TTreeCache::GetMissEfficiency ( ) const
inherited

The total efficiency of the 'miss cache' - defined as the ratio of blocks found in the cache versus the number of blocks prefetched.

Definition at line 1836 of file TTreeCache.cxx.

◆ GetMissEfficiencyRel()

Double_t TTreeCache::GetMissEfficiencyRel ( ) const
inherited

Relative efficiency of the 'miss cache' - ratio of the reads found in cache to the number of reads so far.

Definition at line 1860 of file TTreeCache.cxx.

◆ GetName()

◆ GetNFound()

Int_t TTreeCacheUnzip::GetNFound ( )
inline

Definition at line 154 of file TTreeCacheUnzip.h.

◆ GetNMissed()

Int_t TTreeCacheUnzip::GetNMissed ( )
inline

Definition at line 153 of file TTreeCacheUnzip.h.

◆ GetNoCacheBytesRead()

virtual Long64_t TFileCacheRead::GetNoCacheBytesRead ( ) const
inlinevirtualinherited

Definition at line 90 of file TFileCacheRead.h.

◆ GetNoCacheReadCalls()

virtual Int_t TFileCacheRead::GetNoCacheReadCalls ( ) const
inlinevirtualinherited

Definition at line 96 of file TFileCacheRead.h.

◆ GetNseek()

Int_t TFileCacheRead::GetNseek ( ) const
inlineinherited

Definition at line 93 of file TFileCacheRead.h.

◆ GetNtot()

Int_t TFileCacheRead::GetNtot ( ) const
inlineinherited

Definition at line 94 of file TFileCacheRead.h.

◆ GetNUnzip()

Int_t TTreeCacheUnzip::GetNUnzip ( )
inline

Definition at line 152 of file TTreeCacheUnzip.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.

◆ GetOptimizeMisses()

bool TTreeCache::GetOptimizeMisses ( ) const
inlineinherited

Definition at line 138 of file TTreeCache.h.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetParallelUnzip()

TTreeCacheUnzip::EParUnzipMode TTreeCacheUnzip::GetParallelUnzip ( )
static

Static function that returns the parallel option (to indicate an additional thread).

Definition at line 405 of file TTreeCacheUnzip.cxx.

◆ GetPrefetchedBlocks()

Long64_t TFileCacheRead::GetPrefetchedBlocks ( ) const
inlineinherited

Definition at line 98 of file TFileCacheRead.h.

◆ GetPrefetchObj()

TFilePrefetch * TFileCacheRead::GetPrefetchObj ( )
virtualinherited

Definition at line 683 of file TFileCacheRead.cxx.

◆ GetReadCalls()

virtual Int_t TFileCacheRead::GetReadCalls ( ) const
inlinevirtualinherited

Definition at line 95 of file TFileCacheRead.h.

◆ GetRecordHeader()

Int_t TTreeCacheUnzip::GetRecordHeader ( char * buf,
Int_t maxbytes,
Int_t & nbytes,
Int_t & objlen,
Int_t & keylen )

Read the logical record header from the buffer buf.

That must be the pointer tho the header part not the object by itself and must contain data of at least maxbytes Returns nread;

In output arguments:

  • nbytes : number of bytes in record if negative, this is a deleted record if 0, cannot read record, wrong value of argument first
  • objlen : uncompressed object size
  • keylen : length of logical record header

Note that the arguments objlen and keylen are returned only if maxbytes >=16 Note: This was adapted from TFile... so some things dont apply

Definition at line 467 of file TTreeCacheUnzip.cxx.

◆ GetTitle()

const char * TObject::GetTitle ( ) const
virtualinherited

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 in Axis2, TASImage, TAxis, TBaseClass, TClassMenuItem, TEveGeoNode, TEvePointSet, TGaxis, TGGroupFrame, TGLabel, TGLVEntry, TGTextButton, TGTextEntry, TGTextLBEntry, TKey, TMapFile, TNamed, TPad, TPair, TParallelCoordSelect, TParticle, TPaveLabel, TPrimary, TQCommand, TRootIconList, and TVirtualPad.

Definition at line 507 of file TObject.cxx.

◆ GetTree()

TTree * TTreeCache::GetTree ( ) const
inlineinherited

Definition at line 149 of file TTreeCache.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetUnzipBuffer()

Int_t TTreeCacheUnzip::GetUnzipBuffer ( char ** buf,
Long64_t pos,
Int_t len,
bool * free )
overridevirtual

We try to read a buffer that has already been unzipped Returns -1 in case of read failure, 0 in case it's not in the cache and n>0 in case read from cache (number of bytes copied).

pos and len are the original values as were passed to ReadBuffer but instead we will return the inflated buffer. Note!! : If *buf == 0 we will allocate the buffer and it will be the responsibility of the caller to free it... it is useful for example to pass it to the creator of TBuffer

Reimplemented from TFileCacheRead.

Definition at line 666 of file TTreeCacheUnzip.cxx.

◆ GetUnzipGroupSize()

Int_t TTreeCacheUnzip::GetUnzipGroupSize ( )
inline

Definition at line 142 of file TTreeCacheUnzip.h.

◆ 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 TObject::Hash ( ) const
virtualinherited

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.
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
virtual ULong_t Hash() const
Return hash value for this object.
Definition TObject.cxx:539
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented in RooLinkedList, TASImagePlugin, TASPluginGS, TCollection, TEnvRec, TGObject, TGPicture, TIconBoxThumb, TImagePlugin, TNamed, TObjString, TPad, TPair, TParameter< AParamType >, TParameter< Long64_t >, TPave, and TStatistic.

Definition at line 539 of file TObject.cxx.

◆ 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 TTreeCacheUnzip::Init ( )
private

Initialization procedure common to all the constructors.

Definition at line 193 of file TTreeCacheUnzip.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 * TTreeCacheUnzip::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TTreeCache.

Definition at line 159 of file TTreeCacheUnzip.h.

◆ IsAsyncReading()

virtual Bool_t TFileCacheRead::IsAsyncReading ( ) const
inlinevirtualinherited

Definition at line 99 of file TFileCacheRead.h.

◆ IsAutoCreated()

bool TTreeCache::IsAutoCreated ( ) const
inlineinherited

Definition at line 150 of file TTreeCache.h.

◆ 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.

◆ IsEnabled()

virtual bool TTreeCache::IsEnabled ( ) const
inlinevirtualinherited

Definition at line 151 of file TTreeCache.h.

◆ IsEnablePrefetching()

virtual Bool_t TFileCacheRead::IsEnablePrefetching ( ) const
inlinevirtualinherited

Definition at line 101 of file TFileCacheRead.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()

◆ IsLearning()

bool TTreeCache::IsLearning ( ) const
inlineoverridevirtualinherited

Reimplemented from TFileCacheRead.

Definition at line 152 of file TTreeCache.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsParallelUnzip()

bool TTreeCacheUnzip::IsParallelUnzip ( )
static

Static function that tells wether the multithreading unzipping is activated.

Definition at line 413 of file TTreeCacheUnzip.cxx.

◆ IsSortable()

virtual Bool_t TObject::IsSortable ( ) const
inlinevirtualinherited

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ LearnBranch()

Int_t TTreeCache::LearnBranch ( TBranch * b,
bool subbranches = false )
overridevirtualinherited

Add a branch discovered by actual usage to the list of branches to be stored in the cache this function is called by TBranch::GetBasket If we are not longer in the training phase this is an error.

Returns:

  • 0 branch added or already included
  • -1 on error

Reimplemented from TFileCacheRead.

Definition at line 349 of file TTreeCache.cxx.

◆ LearnPrefill()

void TTreeCache::LearnPrefill ( )
virtualinherited

Perform an initial prefetch, attempting to read as much of the learning phase baskets for all branches at once.

Definition at line 2250 of file TTreeCache.cxx.

◆ ls()

◆ 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.

◆ 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=()

TTreeCacheUnzip & TTreeCacheUnzip::operator= ( const TTreeCacheUnzip & )
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.

◆ Prefetch()

void TFileCacheRead::Prefetch ( Long64_t pos,
Int_t len )
virtualinherited

Add block of length len at position pos in the list of blocks to be prefetched.

If pos <= 0 the current blocks (if any) are reset.

Definition at line 201 of file TFileCacheRead.cxx.

◆ Print()

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

Print cache statistics.

Like:

******TreeCache statistics for file: cms2.root ******
Number of branches in the cache ...: 1093
Cache Efficiency ..................: 0.997372
Cache Efficiency Rel...............: 1.000000
Learn entries......................: 100
Reading............................: 72761843 bytes in 7 transactions
Readahead..........................: 256000 bytes with overhead = 0 bytes
Average transaction................: 10394.549000 Kbytes
Number of blocks in current cache..: 210, total size: 6280352
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
static unsigned int total
  • if option = "a" the list of blocks in the cache is printed see also class TTreePerfStats.
  • if option contains 'cachedbranches', the list of branches being cached is printed.

Reimplemented from TTreeCache.

Definition at line 954 of file TTreeCacheUnzip.cxx.

◆ ProcessMiss()

bool TTreeCache::ProcessMiss ( Long64_t pos,
int len )
privateinherited

! Given a file read not in the miss cache, handle (possibly) loading the data.

Process a cache miss; (pos, len) isn't in the buffer.

The first time we have a miss, we buffer as many baskets we can (up to the maximum size of the TTreeCache) in memory from all branches that are not in the prefetch list.

Subsequent times, we fetch all the buffers corresponding to branches that had previously seen misses. If it turns out the (pos, len) isn't in the list of branches, we treat this as if it was the first miss.

Returns true if we were able to pull the data into the miss cache.

Definition at line 862 of file TTreeCache.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.

◆ ReadBuffer()

Int_t TTreeCache::ReadBuffer ( char * buf,
Long64_t pos,
Int_t len )
overridevirtualinherited

Read buffer at position pos if the request is in the list of prefetched blocks read from fBuffer.

Otherwise try to fill the cache from the list of selected branches, and recheck if pos is now in the list. Returns:

  • -1 in case of read failure,
  • 0 in case not in cache,
  • 1 in case read from cache. This function overloads TFileCacheRead::ReadBuffer.

Reimplemented from TFileCacheRead.

Definition at line 2026 of file TTreeCache.cxx.

◆ ReadBufferExt()

Int_t TTreeCacheUnzip::ReadBufferExt ( char * buf,
Long64_t pos,
Int_t len,
Int_t & loc )
overridevirtual

Reimplemented from TFileCacheRead.

Definition at line 968 of file TTreeCacheUnzip.cxx.

◆ ReadBufferExtNormal()

Int_t TFileCacheRead::ReadBufferExtNormal ( char * buf,
Long64_t pos,
Int_t len,
Int_t & loc )
virtualinherited

Base function for ReadBuffer.

Also gives out the position of the block in the internal buffer. This helps TTreeCacheUnzip to avoid doing twice the binary search.

Definition at line 453 of file TFileCacheRead.cxx.

◆ ReadBufferExtPrefetch()

Int_t TFileCacheRead::ReadBufferExtPrefetch ( char * buf,
Long64_t pos,
Int_t len,
Int_t & loc )
virtualinherited

prefetch the first block

Definition at line 393 of file TFileCacheRead.cxx.

◆ ReadBufferNormal()

Int_t TTreeCache::ReadBufferNormal ( char * buf,
Long64_t pos,
Int_t len )
virtualinherited

Old method ReadBuffer before the addition of the prefetch mechanism.

Definition at line 1926 of file TTreeCache.cxx.

◆ ReadBufferPrefetch()

Int_t TTreeCache::ReadBufferPrefetch ( char * buf,
Long64_t pos,
Int_t len )
virtualinherited

Used to read a chunk from a block previously fetched.

It will call FillBuffer even if the cache lookup succeeds, because it will try to prefetch the next block as soon as we start reading from the current block.

Definition at line 1985 of file TTreeCache.cxx.

◆ RecursiveRemove()

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ ResetCache()

void TTreeCacheUnzip::ResetCache ( )
overridevirtual

This will delete the list of buffers that are in the unzipping cache and will reset certain values in the cache.

This name is ambiguos because the method doesn't reset the whole cache, only the part related to the unzipping Note: This method is completely different from TTreeCache::ResetCache(), in that method we were cleaning the prefetching buffer while here we delete the information about the unzipped buffers

Reimplemented from TTreeCache.

Definition at line 499 of file TTreeCacheUnzip.cxx.

◆ ResetMissCache()

void TTreeCache::ResetMissCache ( )
inherited

Reset all the miss cache training.

The contents of the miss cache will be emptied as well as the list of branches used.

Definition at line 696 of file TTreeCache.cxx.

◆ 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.

◆ 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.

◆ 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.

◆ SecondPrefetch()

void TFileCacheRead::SecondPrefetch ( Long64_t pos,
Int_t len )
virtualinherited

Definition at line 258 of file TFileCacheRead.cxx.

◆ SecondSort()

void TFileCacheRead::SecondSort ( )
virtualinherited

Sort buffers to be prefetched in increasing order of positions.

Merge consecutive blocks if necessary.

Definition at line 629 of file TFileCacheRead.cxx.

◆ SetAutoCreated()

void TTreeCache::SetAutoCreated ( bool val)
inlineinherited

Definition at line 164 of file TTreeCache.h.

◆ 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.

◆ SetBufferSize()

Int_t TTreeCacheUnzip::SetBufferSize ( Long64_t buffersize)
overridevirtual

Change the underlying buffer size of the cache.

The buffersize might be clamped, see TFileCacheRead::SetBufferSize Returns:

  • 0 if the buffer content is still available
  • 1 if some or all of the buffer content has been made unavailable
  • -1 on error

Reimplemented from TTreeCache.

Definition at line 357 of file TTreeCacheUnzip.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.

◆ SetEnablePrefetching()

void TFileCacheRead::SetEnablePrefetching ( Bool_t setPrefetching = kFALSE)
virtualinherited

Set the prefetching mode of this file.

If 'setPrefetching', enable the asynchronous prefetching (using TFilePrefetch) and if the gEnv and rootrc variable Cache.Directory is set, also enable the local caching of the prefetched blocks. if 'setPrefetching', the old prefetcher is enabled is the gEnv and rootrc variable is TFile.AsyncReading

Definition at line 773 of file TFileCacheRead.cxx.

◆ SetEnablePrefetchingImpl()

void TFileCacheRead::SetEnablePrefetchingImpl ( Bool_t setPrefetching = kFALSE)
protectedinherited

TFileCacheRead implementation of SetEnablePrefetching.

This function is called from the constructor and should not be virtual.

Definition at line 783 of file TFileCacheRead.cxx.

◆ SetEntryRange()

void TTreeCacheUnzip::SetEntryRange ( Long64_t emin,
Long64_t emax )
overridevirtual

Set the minimum and maximum entry number to be processed this information helps to optimize the number of baskets to read when prefetching the branch buffers.

Reimplemented from TTreeCache.

Definition at line 373 of file TTreeCacheUnzip.cxx.

◆ SetFile()

void TTreeCache::SetFile ( TFile * file,
TFile::ECacheAction action = TFile::kDisconnect )
overridevirtualinherited

Change the file that is being cached.

Reimplemented from TFileCacheRead.

Definition at line 2127 of file TTreeCache.cxx.

◆ SetLearnEntries()

void TTreeCache::SetLearnEntries ( Int_t n = 10)
staticinherited

Static function to set the number of entries to be used in learning mode The default value for n is 10.

n must be >= 1

Definition at line 2144 of file TTreeCache.cxx.

◆ SetLearnPrefill()

void TTreeCache::SetLearnPrefill ( TTreeCache::EPrefillType type = kNoPrefill)
virtualinherited

Set whether the learning period is started with a prefilling of the cache and which type of prefilling is used.

The two value currently supported are:

  • TTreeCache::kNoPrefill disable the prefilling
  • TTreeCache::kAllBranches fill the cache with baskets from all branches. The default prefilling behavior can be controlled by setting TTreeCache.Prefill or the environment variable ROOT_TTREECACHE_PREFILL.

Definition at line 2159 of file TTreeCache.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.

◆ SetOptimizeMisses()

void TTreeCache::SetOptimizeMisses ( bool opt)
inherited

Start of methods for the miss cache.

Enable / disable the miss cache.

The first time this is called on a TTreeCache object, the corresponding data structures will be allocated. Subsequent enable / disables will simply turn the functionality on/off.

Definition at line 682 of file TTreeCache.cxx.

◆ SetParallelUnzip()

Int_t TTreeCacheUnzip::SetParallelUnzip ( TTreeCacheUnzip::EParUnzipMode option = TTreeCacheUnzip::kEnable)
static

Static function that (de)activates multithreading unzipping.

The possible options are:

  • kEnable Enable it, which causes an automatic detection and launches the additional thread if the number of cores in the machine is greater than one
  • kDisable Disable will not activate the additional thread.
  • kForce Force will start the additional thread even if there is only one core. the default will be taken as kEnable.

Returns 0 if there was an error, 1 otherwise.

Definition at line 434 of file TTreeCacheUnzip.cxx.

◆ SetSkipZip()

virtual void TFileCacheRead::SetSkipZip ( Bool_t = kTRUE)
inlinevirtualinherited

Definition at line 112 of file TFileCacheRead.h.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetUnzipBufferSize()

void TTreeCacheUnzip::SetUnzipBufferSize ( Long64_t bufferSize)

Sets the size for the unzipping cache... by default it should be two times the size of the prefetching cache.

Definition at line 837 of file TTreeCacheUnzip.cxx.

◆ SetUnzipGroupSize()

void TTreeCacheUnzip::SetUnzipGroupSize ( Int_t groupSize)
inline

Definition at line 146 of file TTreeCacheUnzip.h.

◆ SetUnzipRelBufferSize()

void TTreeCacheUnzip::SetUnzipRelBufferSize ( Float_t relbufferSize)
static

static function: Sets the unzip relative buffer size

Definition at line 828 of file TTreeCacheUnzip.cxx.

◆ Sort()

void TFileCacheRead::Sort ( )
virtualinherited

Sort buffers to be prefetched in increasing order of positions.

Merge consecutive blocks if necessary.

Definition at line 571 of file TFileCacheRead.cxx.

◆ StartLearningPhase()

void TTreeCache::StartLearningPhase ( )
inherited

The name should be enough to explain the method.

The only additional comments is that the cache is cleaned before the new learning phase.

Definition at line 2169 of file TTreeCache.cxx.

◆ StopLearningPhase()

void TTreeCacheUnzip::StopLearningPhase ( )
overridevirtual

It's the same as TTreeCache::StopLearningPhase but we guarantee that we start the unzipping just after getting the buffers.

Reimplemented from TTreeCache.

Definition at line 382 of file TTreeCacheUnzip.cxx.

◆ Streamer()

void TTreeCacheUnzip::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TTreeCache.

◆ StreamerNVirtual()

void TTreeCacheUnzip::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 159 of file TTreeCacheUnzip.h.

◆ 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.

◆ UnzipBuffer()

Int_t TTreeCacheUnzip::UnzipBuffer ( char ** dest,
char * src )

Unzips a ROOT specific buffer... by reading the header at the beginning.

returns the size of the inflated buffer or -1 if error Note!! : If *dest == 0 we will allocate the buffer and it will be the responsibility of the caller to free it... it is useful for example to pass it to the creator of TBuffer src is the original buffer with the record (header+compressed data) *dest is the inflated buffer (including the header)

Definition at line 851 of file TTreeCacheUnzip.cxx.

◆ UnzipCache()

Int_t TTreeCacheUnzip::UnzipCache ( Int_t index)

This inflates a basket in the cache.

. passing the data to a new buffer that will only wait there to be read... This function is responsible to update corresponding elements in fUnzipStatus, fUnzipChunks and fUnzipLen. Since we use atomic variables in fUnzipStatus to exclusively unzip the basket, we must update fUnzipStatus after fUnzipChunks and fUnzipLen and make sure fUnzipChunks and fUnzipLen are ready before main thread fetch the data.

Definition at line 524 of file TTreeCacheUnzip.cxx.

◆ UpdateBranches()

void TTreeCacheUnzip::UpdateBranches ( TTree * tree)
overridevirtual

update pointer to current Tree and recompute pointers to the branches in the cache

Reimplemented from TTreeCache.

Definition at line 390 of file TTreeCacheUnzip.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.

◆ WaitFinishPrefetch()

void TFileCacheRead::WaitFinishPrefetch ( )
virtualinherited

Definition at line 690 of file TFileCacheRead.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.

Member Data Documentation

◆ fAsyncReading

bool TTreeCacheUnzip::fAsyncReading
protected

Definition at line 81 of file TTreeCacheUnzip.h.

◆ fAutoCreated

bool TTreeCache::fAutoCreated {false}
protectedinherited

! true if cache was automatically created

Definition at line 66 of file TTreeCache.h.

◆ fBIsSorted

Bool_t TFileCacheRead::fBIsSorted
protectedinherited

Definition at line 70 of file TFileCacheRead.h.

◆ fBIsTransferred

Bool_t TFileCacheRead::fBIsTransferred
protectedinherited

Definition at line 71 of file TFileCacheRead.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBLen

Int_t* TFileCacheRead::fBLen
protectedinherited

[fBNb]

Definition at line 69 of file TFileCacheRead.h.

◆ fBNb

Int_t TFileCacheRead::fBNb
protectedinherited

Definition at line 60 of file TFileCacheRead.h.

◆ fBNseek

Int_t TFileCacheRead::fBNseek
protectedinherited

Definition at line 58 of file TFileCacheRead.h.

◆ fBNtot

Int_t TFileCacheRead::fBNtot
protectedinherited

Definition at line 59 of file TFileCacheRead.h.

◆ fBPos

Long64_t* TFileCacheRead::fBPos
protectedinherited

[fBNb]

Definition at line 65 of file TFileCacheRead.h.

◆ fBranches

TObjArray* TTreeCache::fBranches {nullptr}
protectedinherited

! List of branches to be stored in the cache

Definition at line 51 of file TTreeCache.h.

◆ fBrNames

TList* TTreeCache::fBrNames {nullptr}
protectedinherited

! list of branch names in the cache

Definition at line 52 of file TTreeCache.h.

◆ fBSeek

Long64_t* TFileCacheRead::fBSeek
protectedinherited

[fBNseek]

Definition at line 62 of file TFileCacheRead.h.

◆ fBSeekIndex

Int_t* TFileCacheRead::fBSeekIndex
protectedinherited

[fBNseek]

Definition at line 64 of file TFileCacheRead.h.

◆ fBSeekLen

Int_t* TFileCacheRead::fBSeekLen
protectedinherited

[fBNseek]

Definition at line 66 of file TFileCacheRead.h.

◆ fBSeekPos

Int_t* TFileCacheRead::fBSeekPos
protectedinherited

[fBNseek]

Definition at line 68 of file TFileCacheRead.h.

◆ fBSeekSize

Int_t TFileCacheRead::fBSeekSize
protectedinherited

Definition at line 61 of file TFileCacheRead.h.

◆ fBSeekSort

Long64_t* TFileCacheRead::fBSeekSort
protectedinherited

[fBNseek]

Definition at line 63 of file TFileCacheRead.h.

◆ fBSeekSortLen

Int_t* TFileCacheRead::fBSeekSortLen
protectedinherited

[fBNseek]

Definition at line 67 of file TFileCacheRead.h.

◆ fBuffer

char* TFileCacheRead::fBuffer
protectedinherited

[fBufferSize] buffer of contiguous prefetched blocks

Definition at line 52 of file TFileCacheRead.h.

◆ fBufferLen

Int_t TFileCacheRead::fBufferLen
protectedinherited

Current buffer length (<= fBufferSize).

Definition at line 28 of file TFileCacheRead.h.

◆ fBufferSize

Int_t TFileCacheRead::fBufferSize
protectedinherited

Allocated size of fBuffer (at a given time).

Definition at line 27 of file TFileCacheRead.h.

◆ fBufferSizeMin

Int_t TFileCacheRead::fBufferSizeMin
protectedinherited

Original size of fBuffer.

Definition at line 26 of file TFileCacheRead.h.

◆ fBytesRead

Long64_t TFileCacheRead::fBytesRead
protectedinherited

Number of bytes read for this cache.

Definition at line 30 of file TFileCacheRead.h.

◆ fBytesReadExtra

Long64_t TFileCacheRead::fBytesReadExtra
protectedinherited

Number of extra bytes (overhead) read by the readahead buffer.

Definition at line 31 of file TFileCacheRead.h.

◆ fCompBuffer

char* TTreeCacheUnzip::fCompBuffer
private

Definition at line 112 of file TTreeCacheUnzip.h.

◆ fCompBufferSize

Int_t TTreeCacheUnzip::fCompBufferSize
private

Definition at line 113 of file TTreeCacheUnzip.h.

◆ fCurrentClusterStart

Long64_t TTreeCache::fCurrentClusterStart {-1}
protectedinherited

! Start of the cluster(s) where the current content was picked out

Definition at line 42 of file TTreeCache.h.

◆ fCycle

Int_t TTreeCacheUnzip::fCycle
protected

Definition at line 83 of file TTreeCacheUnzip.h.

◆ fEmpty

bool TTreeCacheUnzip::fEmpty
protected

Definition at line 82 of file TTreeCacheUnzip.h.

◆ fEnabled

bool TTreeCache::fEnabled {true}
protectedinherited

! cache enabled for cached reading

Definition at line 63 of file TTreeCache.h.

◆ fEnablePrefetching

Bool_t TFileCacheRead::fEnablePrefetching
protectedinherited

reading by prefetching asynchronously

Definition at line 37 of file TFileCacheRead.h.

◆ fEntryCurrent

Long64_t TTreeCache::fEntryCurrent {-1}
protectedinherited

! current lowest entry number in the cache

Definition at line 40 of file TTreeCache.h.

◆ fEntryMax

Long64_t TTreeCache::fEntryMax {1}
protectedinherited

! last entry in the cache

Definition at line 39 of file TTreeCache.h.

◆ fEntryMin

Long64_t TTreeCache::fEntryMin {0}
protectedinherited

! first entry in the cache

Definition at line 38 of file TTreeCache.h.

◆ fEntryNext

Long64_t TTreeCache::fEntryNext {-1}
protectedinherited

! next entry number where cache must be filled

Definition at line 41 of file TTreeCache.h.

◆ fFile

TFile* TFileCacheRead::fFile
protectedinherited

Pointer to file.

Definition at line 51 of file TFileCacheRead.h.

◆ fFillTimes

Int_t TTreeCache::fFillTimes {0}
protectedinherited

! how many times we can fill the current buffer

Definition at line 59 of file TTreeCache.h.

◆ fFirstBuffer

bool TTreeCache::fFirstBuffer {true}
protectedinherited

! true if first buffer is used for prefetching

Definition at line 56 of file TTreeCache.h.

◆ fFirstEntry

Long64_t TTreeCache::fFirstEntry {-1}
protectedinherited

! save the value of the first entry

Definition at line 61 of file TTreeCache.h.

◆ fFirstMiss

Long64_t TTreeCache::fFirstMiss {-1}
protectedinherited

! set to the event # of the first miss.

Definition at line 73 of file TTreeCache.h.

◆ fFirstTime

bool TTreeCache::fFirstTime {true}
protectedinherited

! save the fact that we processes the first entry

Definition at line 60 of file TTreeCache.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.

◆ fgLearnEntries

Int_t TTreeCache::fgLearnEntries = 100
staticprotectedinherited

number of entries used for learning mode

Definition at line 65 of file TTreeCache.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fgParallel

TTreeCacheUnzip::EParUnzipMode TTreeCacheUnzip::fgParallel = TTreeCacheUnzip::kDisable
staticprotected

Indicate if we want to activate the parallelism.

Definition at line 88 of file TTreeCacheUnzip.h.

◆ fgRelBuffSize

Double_t TTreeCacheUnzip::fgRelBuffSize = .5
staticprotected

This is the percentage of the TTreeCacheUnzip that will be used.

Definition at line 100 of file TTreeCacheUnzip.h.

◆ fIOMutex

std::unique_ptr<TMutex> TTreeCacheUnzip::fIOMutex
protected

Definition at line 86 of file TTreeCacheUnzip.h.

◆ fIsLearning

bool TTreeCache::fIsLearning {true}
protectedinherited

! true if cache is in learning mode

Definition at line 54 of file TTreeCache.h.

◆ fIsManual

bool TTreeCache::fIsManual {false}
protectedinherited

! true if cache is StopLearningPhase was used

Definition at line 55 of file TTreeCache.h.

◆ fIsSorted

Bool_t TFileCacheRead::fIsSorted
protectedinherited

True if fSeek array is sorted.

Definition at line 53 of file TFileCacheRead.h.

◆ fIsTransferred

Bool_t TFileCacheRead::fIsTransferred
protectedinherited

True when fBuffer contains something valid.

Definition at line 54 of file TFileCacheRead.h.

◆ fLastMiss

Long64_t TTreeCache::fLastMiss {-1}
protectedinherited

! set to the event # of the last miss.

Definition at line 74 of file TTreeCache.h.

◆ fLearnPrefilling

bool TTreeCache::fLearnPrefilling {false}
protectedinherited

! true if we are in the process of executing LearnPrefill

Definition at line 68 of file TTreeCache.h.

◆ fLen

Int_t* TFileCacheRead::fLen
protectedinherited

[fNb] Length of long buffers

Definition at line 50 of file TFileCacheRead.h.

◆ fMissCache

std::unique_ptr<MissCache> TTreeCache::fMissCache
protectedinherited

! Cache contents for misses

Definition at line 105 of file TTreeCache.h.

◆ fNb

Int_t TFileCacheRead::fNb
protectedinherited

Number of long buffers.

Definition at line 41 of file TFileCacheRead.h.

◆ fNbranches

Int_t TTreeCache::fNbranches {0}
protectedinherited

! Number of branches in the cache

Definition at line 44 of file TTreeCache.h.

◆ fNextClusterStart

Long64_t TTreeCache::fNextClusterStart {-1}
protectedinherited

! End+1 of the cluster(s) where the current content was picked out

Definition at line 43 of file TTreeCache.h.

◆ fNFound

Int_t TTreeCacheUnzip::fNFound
protected

! number of blocks that were found in the cache

Definition at line 103 of file TTreeCacheUnzip.h.

◆ fNMissed

Int_t TTreeCacheUnzip::fNMissed
protected

! number of blocks that were not found in the cache and were unzipped

Definition at line 104 of file TTreeCacheUnzip.h.

◆ fNMissReadMiss

Int_t TTreeCache::fNMissReadMiss {0}
protectedinherited

Number of blocks read and not found in either cache.

Definition at line 48 of file TTreeCache.h.

◆ fNMissReadOk

Int_t TTreeCache::fNMissReadOk {0}
protectedinherited

Number of blocks read, not found in the primary cache, and found in the secondary cache.

Definition at line 46 of file TTreeCache.h.

◆ fNMissReadPref

Int_t TTreeCache::fNMissReadPref {0}
protectedinherited

Number of blocks read into the secondary ("miss") cache.

Definition at line 50 of file TTreeCache.h.

◆ fNoCacheBytesRead

Long64_t TFileCacheRead::fNoCacheBytesRead
protectedinherited

Number of bytes read by basket to fill cached tree.

Definition at line 33 of file TFileCacheRead.h.

◆ fNoCacheReadCalls

Int_t TFileCacheRead::fNoCacheReadCalls
protectedinherited

Number of read calls by basket to fill cached tree.

Definition at line 34 of file TFileCacheRead.h.

◆ fNReadMiss

Int_t TTreeCache::fNReadMiss {0}
protectedinherited

Number of blocks read and not found in the cache.

Definition at line 47 of file TTreeCache.h.

◆ fNReadOk

Int_t TTreeCache::fNReadOk {0}
protectedinherited

Number of blocks read and found in the cache.

Definition at line 45 of file TTreeCache.h.

◆ fNReadPref

Int_t TTreeCache::fNReadPref {0}
protectedinherited

Number of blocks that were prefetched.

Definition at line 49 of file TTreeCache.h.

◆ fNseek

Int_t TFileCacheRead::fNseek
protectedinherited

Number of blocks to be prefetched.

Definition at line 39 of file TFileCacheRead.h.

◆ fNseekMax

Int_t TTreeCacheUnzip::fNseekMax
protected

! fNseek can change so we need to know its max size

Definition at line 96 of file TTreeCacheUnzip.h.

◆ fNStalls

Int_t TTreeCacheUnzip::fNStalls
protected

! number of hits which caused a stall

Definition at line 105 of file TTreeCacheUnzip.h.

◆ fNtot

Int_t TFileCacheRead::fNtot
protectedinherited

Total size of prefetched blocks.

Definition at line 40 of file TFileCacheRead.h.

◆ fNUnzip

Int_t TTreeCacheUnzip::fNUnzip
protected

! number of blocks that were unzipped

Definition at line 106 of file TTreeCacheUnzip.h.

◆ fOneTime

bool TTreeCache::fOneTime {false}
protectedinherited

! used in the learning phase

Definition at line 57 of file TTreeCache.h.

◆ fOptimizeMisses

bool TTreeCache::fOptimizeMisses {false}
protectedinherited

! true if we should optimize cache misses.

Definition at line 72 of file TTreeCache.h.

◆ fParallel

bool TTreeCacheUnzip::fParallel
protected

Indicate if we want to activate the parallelism (for this instance).

Definition at line 84 of file TTreeCacheUnzip.h.

◆ fPos

Long64_t* TFileCacheRead::fPos
protectedinherited

[fNb] start of long buffers

Definition at line 46 of file TFileCacheRead.h.

◆ fPrefetch

TFilePrefetch* TFileCacheRead::fPrefetch
protectedinherited

! Object that does the asynchronous reading in another thread

Definition at line 25 of file TFileCacheRead.h.

◆ fPrefetchedBlocks

Long64_t TFileCacheRead::fPrefetchedBlocks
protectedinherited

Number of blocks prefetched.

Definition at line 55 of file TFileCacheRead.h.

◆ fPrefillType

EPrefillType TTreeCache::fPrefillType
protectedinherited

Whether a pre-filling is enabled (and if applicable which type).

Definition at line 64 of file TTreeCache.h.

◆ fReadCalls

Int_t TFileCacheRead::fReadCalls
protectedinherited

Number of read calls for this cache.

Definition at line 32 of file TFileCacheRead.h.

◆ fReadDirectionSet

bool TTreeCache::fReadDirectionSet {false}
protectedinherited

! read direction established

Definition at line 62 of file TTreeCache.h.

◆ fReverseRead

bool TTreeCache::fReverseRead {false}
protectedinherited

! reading in reverse mode

Definition at line 58 of file TTreeCache.h.

◆ fSeek

Long64_t* TFileCacheRead::fSeek
protectedinherited

[fNseek] Position on file of buffers to be prefetched

Definition at line 43 of file TFileCacheRead.h.

◆ fSeekIndex

Int_t* TFileCacheRead::fSeekIndex
protectedinherited

[fNseek] sorted index table of fSeek

Definition at line 45 of file TFileCacheRead.h.

◆ fSeekLen

Int_t* TFileCacheRead::fSeekLen
protectedinherited

[fNseek] Length of buffers to be prefetched

Definition at line 47 of file TFileCacheRead.h.

◆ fSeekPos

Int_t* TFileCacheRead::fSeekPos
protectedinherited

[fNseek] Position of sorted blocks in fBuffer

Definition at line 49 of file TFileCacheRead.h.

◆ fSeekSize

Int_t TFileCacheRead::fSeekSize
protectedinherited

Allocated size of fSeek.

Definition at line 42 of file TFileCacheRead.h.

◆ fSeekSort

Long64_t* TFileCacheRead::fSeekSort
protectedinherited

[fNseek] Position on file of buffers to be prefetched (sorted)

Definition at line 44 of file TFileCacheRead.h.

◆ fSeekSortLen

Int_t* TFileCacheRead::fSeekSortLen
protectedinherited

[fNseek] Length of buffers to be prefetched (sorted)

Definition at line 48 of file TFileCacheRead.h.

◆ fTree

TTree* TTreeCache::fTree {nullptr}
protectedinherited

! pointer to the current Tree

Definition at line 53 of file TTreeCache.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fUnzipBufferSize

Long64_t TTreeCacheUnzip::fUnzipBufferSize
protected

! Max Size for the ready unzipped blocks (default is 2*fBufferSize)

Definition at line 98 of file TTreeCacheUnzip.h.

◆ fUnzipGroupSize

Int_t TTreeCacheUnzip::fUnzipGroupSize
protected

! Min accumulated size of a group of baskets ready to be unzipped by a IMT task

Definition at line 97 of file TTreeCacheUnzip.h.

◆ fUnzipState

UnzipState_t TTreeCacheUnzip::fUnzipState
protected

Definition at line 78 of file TTreeCacheUnzip.h.

◆ fUnzipTaskGroup

std::unique_ptr<ROOT::Experimental::TTaskGroup> TTreeCacheUnzip::fUnzipTaskGroup
protected

Definition at line 92 of file TTreeCacheUnzip.h.


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