FWTTreeCache Class Reference

#include <FWTTreeCache.h>

Inheritance diagram for FWTTreeCache:

Classes
struct	LearnGuard

Public Member Functions
Int_t	AddBranch (const char *branch, Bool_t subbranches=kFALSE) override
Int_t	AddBranch (TBranch *b, Bool_t subbranches=kFALSE) override
Int_t	AddBranchTopLevel (const char *bname)
void	BranchAccessCallIn (const TBranch *b)
Int_t	DropBranch (const char *branch, Bool_t subbranches=kFALSE) override
Int_t	DropBranch (TBranch *b, Bool_t subbranches=kFALSE) override
Int_t	DropBranchTopLevel (const char *bname)
	FWTTreeCache ()
	FWTTreeCache (TTree *tree, Int_t buffersize=0)
	~FWTTreeCache () override

Static Public Member Functions
static int	GetDefaultCacheSize ()
static bool	IsLogging ()
static bool	IsPrefetching ()
static void	LoggingOff ()
static void	LoggingOn ()
static void	PrefetchingOff ()
static void	PrefetchingOn ()
static void	SetDefaultCacheSize (int def_size)

Protected Member Functions
bool	is_branch_in_cache (const char *name)
bool	start_learning ()
void	stop_learning ()

Private Attributes
std::set< std::string >	m_branch_set
bool	m_silent_low_level = false

Static Private Attributes
static int	s_default_size = 50 * 1024 * 1024
static bool	s_logging = false
static bool	s_prefetching = false

Detailed Description

Definition at line 9 of file FWTTreeCache.h.

Constructor & Destructor Documentation

FWTTreeCache() [1/2]

FWTTreeCache::FWTTreeCache

(

)

Definition at line 9 of file FWTTreeCache.cc.

: TTreeCache() {}

FWTTreeCache() [2/2]

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

Definition at line 11 of file FWTTreeCache.cc.

: TTreeCache(tree, buffersize) {}

~FWTTreeCache()

FWTTreeCache::~FWTTreeCache ( )

override

Definition at line 13 of file FWTTreeCache.cc.

{}

Member Function Documentation

AddBranch() [1/2]

Int_t FWTTreeCache::AddBranch ( const char *  branch, Bool_t  subbranches = kFALSE  )

override

Definition at line 93 of file FWTTreeCache.cc.

                                                                    {
  if (s_logging)
    printf("FWTTreeCache::AddBranch by name '%s', subbp=%d\n", branch, subbranches);
  if (strcmp(branch, "*") == 0)
    m_silent_low_level = true;
  return TTreeCache::AddBranch(branch, subbranches);
}

References MicroEventContent_cff::branch, m_silent_low_level, and s_logging.

AddBranch() [2/2]

Int_t FWTTreeCache::AddBranch ( TBranch *  b, Bool_t  subbranches = kFALSE  )

override

Definition at line 87 of file FWTTreeCache.cc.

                                                            {
  if (s_logging && !m_silent_low_level)
    printf("FWTTreeCache::AddBranch by ptr '%s', subbp=%d\n", b->GetName(), subbranches);
  return TTreeCache::AddBranch(b, subbranches);
}

References b, m_silent_low_level, and s_logging.

Referenced by AddBranchTopLevel().

AddBranchTopLevel()

Int_t FWTTreeCache::AddBranchTopLevel

(

const char *

bname

)

Definition at line 34 of file FWTTreeCache.cc.

                                                       {
  if (bname == nullptr || bname[0] == 0) {
    printf("FWTTreeCache::AddBranchTopLevel Invalid branch name <%s>\n", bname == nullptr ? "nullptr" : "empty string");
    return -1;
  }
 
  Int_t ret = 0;
  if (!is_branch_in_cache(bname)) {
    if (s_logging)
      printf("FWTTreeCache::AddBranchTopLevel '%s' -- adding\n", bname);
    {
      LearnGuard _lg(this);
      ret = AddBranch(bname, true);
    }
    if (ret == 0)
      m_branch_set.insert(bname);
  } else {
    if (s_logging)
      printf("FWTTreeCache::AddBranchTopLevel '%s' -- already in cache\n", bname);
  }
 
  return ret;
}

References AddBranch(), is_branch_in_cache(), m_branch_set, runTheMatrix::ret, and s_logging.

Referenced by BranchAccessCallIn().

BranchAccessCallIn()

void FWTTreeCache::BranchAccessCallIn

(

const TBranch *

b

)

Definition at line 78 of file FWTTreeCache.cc.

                                                      {
  if (s_logging)
    printf("FWTTreeCache::BranchAccessCallIn '%s'\n", b->GetName());
 
  AddBranchTopLevel(b->GetName());
}

References AddBranchTopLevel(), b, and s_logging.

DropBranch() [1/2]

Int_t FWTTreeCache::DropBranch ( const char *  branch, Bool_t  subbranches = kFALSE  )

override

Definition at line 107 of file FWTTreeCache.cc.

                                                                     {
  if (s_logging)
    printf("FWTTreeCache::DropBranch by name '%s', subbp=%d\n", branch, subbranches);
  Int_t ret = TTreeCache::DropBranch(branch, subbranches);
  if (strcmp(branch, "*") == 0)
    m_silent_low_level = false;
  return ret;
}

References MicroEventContent_cff::branch, m_silent_low_level, runTheMatrix::ret, and s_logging.

DropBranch() [2/2]

Int_t FWTTreeCache::DropBranch ( TBranch *  b, Bool_t  subbranches = kFALSE  )

override

Definition at line 101 of file FWTTreeCache.cc.

                                                             {
  if (s_logging && !m_silent_low_level)
    printf("FWTTreeCache::DropBranch by ptr '%s', subbp=%d\n", b->GetName(), subbranches);
  return TTreeCache::DropBranch(b, subbranches);
}

References b, m_silent_low_level, and s_logging.

Referenced by DropBranchTopLevel().

DropBranchTopLevel()

Int_t FWTTreeCache::DropBranchTopLevel

(

const char *

bname

)

Definition at line 58 of file FWTTreeCache.cc.

                                                        {
  if (bname == nullptr || bname[0] == 0) {
    printf("FWTTreeCache::AddBranchTopLevel Invalid branch name");
    return -1;
  }
 
  Int_t ret = 0;
  if (is_branch_in_cache(bname)) {
    if (s_logging)
      printf("FWTTreeCache::DropBranchTopLevel '%s' -- dropping\n", bname);
    m_branch_set.erase(bname);
    LearnGuard _lg(this);
    ret = DropBranch(bname, true);
  } else {
    if (s_logging)
      printf("FWTTreeCache::DropBranchTopLevel '%s' -- not in cache\n", bname);
  }
  return ret;
}

References DropBranch(), is_branch_in_cache(), m_branch_set, runTheMatrix::ret, and s_logging.

GetDefaultCacheSize()

int FWTTreeCache::GetDefaultCacheSize ( )

static

Definition at line 30 of file FWTTreeCache.cc.

{ return s_default_size; }

References s_default_size.

Referenced by FWFileEntry::openFile().

is_branch_in_cache()

bool FWTTreeCache::is_branch_in_cache ( const char *  name )

inlineprotected

Definition at line 18 of file FWTTreeCache.h.

{ return (m_branch_set.find(name) != m_branch_set.end()); }

References m_branch_set, and Skims_PA_cff::name.

Referenced by AddBranchTopLevel(), and DropBranchTopLevel().

IsLogging()

bool FWTTreeCache::IsLogging ( )

static

Definition at line 23 of file FWTTreeCache.cc.

{ return s_logging; }

References s_logging.

Referenced by CmsShowNavigator::goTo(), FWFileEntry::NewEventItemCallIn(), FWFileEntry::openFile(), and FWFileEntry::RemovingEventItemCallIn().

IsPrefetching()

bool FWTTreeCache::IsPrefetching ( )

static

Definition at line 27 of file FWTTreeCache.cc.

{ return s_prefetching; }

References s_prefetching.

Referenced by FWFileEntry::openFile(), and FWFileEntry::runFilter().

LoggingOff()

void FWTTreeCache::LoggingOff ( )

static

Definition at line 22 of file FWTTreeCache.cc.

{ s_logging = false; }

References s_logging.

LoggingOn()

void FWTTreeCache::LoggingOn ( )

static

Definition at line 21 of file FWTTreeCache.cc.

{ s_logging = true; }

References s_logging.

Referenced by CmsShowMain::CmsShowMain().

PrefetchingOff()

void FWTTreeCache::PrefetchingOff ( )

static

Definition at line 26 of file FWTTreeCache.cc.

{ s_prefetching = false; }

References s_prefetching.

PrefetchingOn()

void FWTTreeCache::PrefetchingOn ( )

static

Definition at line 25 of file FWTTreeCache.cc.

{ s_prefetching = true; }

References s_prefetching.

Referenced by CmsShowMain::CmsShowMain().

SetDefaultCacheSize()

void FWTTreeCache::SetDefaultCacheSize ( int  def_size )

static

Definition at line 29 of file FWTTreeCache.cc.

{ s_default_size = def_size; }

References s_default_size.

Referenced by CmsShowMain::CmsShowMain().

start_learning()

bool FWTTreeCache::start_learning ( )

inlineprotected

Definition at line 20 of file FWTTreeCache.h.

                        {
    if (fIsLearning)
      return true;
    fIsLearning = true;
    return false;
  }

Referenced by FWTTreeCache::LearnGuard::LearnGuard().

stop_learning()

void FWTTreeCache::stop_learning ( )

inlineprotected

Definition at line 26 of file FWTTreeCache.h.

{ fIsLearning = false; }

Referenced by FWTTreeCache::LearnGuard::~LearnGuard().

Member Data Documentation

m_branch_set

std::set<std::string> FWTTreeCache::m_branch_set

private

Definition at line 10 of file FWTTreeCache.h.

Referenced by AddBranchTopLevel(), DropBranchTopLevel(), and is_branch_in_cache().

m_silent_low_level

bool FWTTreeCache::m_silent_low_level = false

private

Definition at line 11 of file FWTTreeCache.h.

Referenced by AddBranch(), DropBranch(), FWTTreeCache::LearnGuard::LearnGuard(), and FWTTreeCache::LearnGuard::~LearnGuard().

s_default_size

int FWTTreeCache::s_default_size = 50 * 1024 * 1024

staticprivate

Definition at line 13 of file FWTTreeCache.h.

Referenced by GetDefaultCacheSize(), and SetDefaultCacheSize().

s_logging

bool FWTTreeCache::s_logging = false

staticprivate

Definition at line 14 of file FWTTreeCache.h.

Referenced by AddBranch(), AddBranchTopLevel(), BranchAccessCallIn(), DropBranch(), DropBranchTopLevel(), IsLogging(), LoggingOff(), and LoggingOn().

s_prefetching

bool FWTTreeCache::s_prefetching = false

staticprivate

Definition at line 15 of file FWTTreeCache.h.

Referenced by IsPrefetching(), PrefetchingOff(), and PrefetchingOn().