TTreeCache.h

Go to the documentation of this file.

// @(#)root/tree:$Id$
// Author: Rene Brun   04/06/2006

/*************************************************************************
 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

#ifndef ROOT_TTreeCache
#define ROOT_TTreeCache


//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TTreeCache                                                           //
//                                                                      //
// Specialization of TFileCacheRead for a TTree                         //
//                                                                      //
//////////////////////////////////////////////////////////////////////////

#ifndef ROOT_TFileCacheRead
#include "TFileCacheRead.h"
#endif
#ifndef ROOT_TObjArray
#include "TObjArray.h"
#endif

class TTree;
class TBranch;

class TTreeCache : public TFileCacheRead {

public:
   enum EPrefillType { kNoPrefill, kAllBranches };

protected:
   Long64_t        fEntryMin;         ///<! first entry in the cache
   Long64_t        fEntryMax;         ///<! last entry in the cache
   Long64_t        fEntryCurrent;     ///<! current lowest entry number in the cache
   Long64_t        fEntryNext;        ///<! next entry number where cache must be filled
   Int_t           fNbranches;        ///<! Number of branches in the cache
   Int_t           fNReadOk;          ///<  Number of blocks read and found in the cache
   Int_t           fNReadMiss;        ///<  Number of blocks read and not found in the cache
   Int_t           fNReadPref;        ///<  Number of blocks that were prefetched
   TObjArray      *fBranches;         ///<! List of branches to be stored in the cache
   TList          *fBrNames;          ///<! list of branch names in the cache
   TTree          *fTree;             ///<! pointer to the current Tree
   Bool_t          fIsLearning;       ///<! true if cache is in learning mode
   Bool_t          fIsManual;         ///<! true if cache is StopLearningPhase was used
   Bool_t          fFirstBuffer;      ///<! true if first buffer is used for prefetching
   Bool_t          fOneTime;          ///<! used in the learning phase
   Bool_t          fReverseRead;      ///<! reading in reverse mode
   Int_t           fFillTimes;        ///<! how many times we can fill the current buffer
   Bool_t          fFirstTime;        ///<! save the fact that we processes the first entry
   Long64_t        fFirstEntry;       ///<! save the value of the first entry
   Bool_t          fReadDirectionSet; ///<! read direction established
   Bool_t          fEnabled;          ///<! cache enabled for cached reading
   EPrefillType    fPrefillType;      ///<  Whether a pre-filling is enabled (and if applicable which type)
   static  Int_t   fgLearnEntries;    ///<  number of entries used for learning mode
   Bool_t          fAutoCreated;      ///<! true if cache was automatically created

private:
   TTreeCache(const TTreeCache &);            //this class cannot be copied
   TTreeCache& operator=(const TTreeCache &);

public:

   TTreeCache();
   TTreeCache(TTree *tree, Int_t buffersize=0);
   virtual ~TTreeCache();
   virtual Int_t        AddBranch(TBranch *b, Bool_t subgbranches = kFALSE);
   virtual Int_t        AddBranch(const char *branch, Bool_t subbranches = kFALSE);
   virtual Int_t        DropBranch(TBranch *b, Bool_t subbranches = kFALSE);
   virtual Int_t        DropBranch(const char *branch, Bool_t subbranches = kFALSE);
   virtual void         Disable() {fEnabled = kFALSE;}
   virtual void         Enable() {fEnabled = kTRUE;}
   const TObjArray     *GetCachedBranches() const { return fBranches; }
   EPrefillType         GetConfiguredPrefillType() const;
   Double_t             GetEfficiency() const;
   Double_t             GetEfficiencyRel() const;
   virtual Int_t        GetEntryMin() const {return fEntryMin;}
   virtual Int_t        GetEntryMax() const {return fEntryMax;}
   static Int_t         GetLearnEntries();
   virtual EPrefillType GetLearnPrefill() const {return fPrefillType;}
   TTree               *GetTree() const {return fTree;}
   Bool_t               IsAutoCreated() const {return fAutoCreated;}
   virtual Bool_t       IsEnabled() const {return fEnabled;}
   virtual Bool_t       IsLearning() const {return fIsLearning;}

   virtual Bool_t       FillBuffer();
   virtual void         LearnPrefill();

   virtual void         Print(Option_t *option="") const;
   virtual Int_t        ReadBuffer(char *buf, Long64_t pos, Int_t len);
   virtual Int_t        ReadBufferNormal(char *buf, Long64_t pos, Int_t len);
   virtual Int_t        ReadBufferPrefetch(char *buf, Long64_t pos, Int_t len);
   virtual void         ResetCache();
   void                 SetAutoCreated(Bool_t val) {fAutoCreated = val;}
   virtual Int_t        SetBufferSize(Int_t buffersize);
   virtual void         SetEntryRange(Long64_t emin,   Long64_t emax);
   virtual void         SetFile(TFile *file, TFile::ECacheAction action=TFile::kDisconnect);
   virtual void         SetLearnPrefill(EPrefillType type = kNoPrefill);
   static void          SetLearnEntries(Int_t n = 10);
   void                 StartLearningPhase();
   virtual void         StopLearningPhase();
   virtual void         UpdateBranches(TTree *tree);

   ClassDef(TTreeCache,2)  //Specialization of TFileCacheRead for a TTree
};

#endif