genie::Cache Class Reference

GENIE Cache Memory. More...

#include "/cvmfs/nova.opensciencegrid.org/externals/genie/v3_00_06_p01a/Linux64bit+3.10-2.17-e19-debug/GENIE-Generator/src/Framework/Utils/Cache.h"

Classes
struct	Cleaner
	proper de-allocation of the singleton object More...

Public Member Functions
void	OpenCacheFile (string filename)
	cache file More...
CacheBranchI *	FindCacheBranch (string key)
	finding/adding cache branches More...
void	AddCacheBranch (string key, CacheBranchI *branch)
string	CacheBranchKey (string k0, string k1="", string k2="") const
void	RmCacheBranch (string key)
	removing cache branches More...
void	RmAllCacheBranches (void)
void	RmMatchedCacheBranches (string key_substring)
void	Print (ostream &stream) const
	print cache buffers More...

Static Public Member Functions
static Cache *	Instance (void)

Private Member Functions
void	Load (void)
	load/save More...
void	Save (void)
	Cache ()
	singleton class: constructors are private More...
	Cache (const Cache &cache)
virtual	~Cache ()

Private Attributes
map< string, CacheBranchI * > *	fCacheMap
	map of cache buffers & cache file More...
TFile *	fCacheFile

Static Private Attributes
static Cache *	fInstance = 0
	singleton instance More...

Friends
struct	Cleaner
ostream &	operator<< (ostream &stream, const Cache &cache)

Detailed Description

GENIE Cache Memory.

Author

Costas Andreopoulos <costas.andreopoulos stfc.ac.uk> University of Liverpool & STFC Rutherford Appleton Lab

November 26, 2004

Copyright (c) 2003-2019, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org or see $GENIE/LICENSE

Definition at line 39 of file Cache.h.

Constructor & Destructor Documentation

genie::Cache::Cache ( )

private

singleton class: constructors are private

Definition at line 46 of file Cache.cxx.

References fCacheFile, fCacheMap, and fInstance.

Referenced by Instance().

{
  fInstance  = 0;
  fCacheMap  = 0;
  fCacheFile = 0;
}

genie::Cache::Cache ( const Cache &  cache )

private

genie::Cache::~Cache ( )

privatevirtual

Definition at line 53 of file Cache.cxx.

References compare_h5_caf::branch, fCacheFile, fCacheMap, fInstance, and Save().

{
  this->Save();

  if(fCacheMap) {
    map<string, CacheBranchI * >::iterator citer;
    for(citer = fCacheMap->begin(); citer != fCacheMap->end(); ++citer) {
      CacheBranchI * branch = citer->second;
      if(branch) {
        delete branch;
        branch = 0;
      }
    }
    fCacheMap->clear();
    delete fCacheMap;
  }
  if(fCacheFile) {
    fCacheFile->Close();
    delete fCacheFile;
  }
  fInstance = 0;
}

Member Function Documentation

void genie::Cache::AddCacheBranch	(	string	key,
		CacheBranchI *	branch
	)

Definition at line 97 of file Cache.cxx.

References fCacheMap.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::QELEventGeneratorSM::AccessCacheBranch2(), genie::QELEventGeneratorSM::AccessCacheBranchDiffv(), genie::DISXSec::CacheFreeNucleonXSec(), genie::DMDISXSec::CacheFreeNucleonXSec(), genie::ReinSehgalRESXSecWithCache::CacheResExcitationXSec(), genie::ReinSehgalRESXSecWithCacheFast::CacheResExcitationXSec(), genie::QPMDISPXSec::DISRESJoinSuppressionFactor(), and genie::QPMDMDISPXSec::DMDISRESJoinSuppressionFactor().

{
  fCacheMap->insert( map<string, CacheBranchI *>::value_type(key,branch) );
}

string genie::Cache::CacheBranchKey	(	string	k0,
		string	k1 = "",
		string	k2 = ""
	)		const

Definition at line 102 of file Cache.cxx.

References findDuplicateFiles::key.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::QELEventGeneratorSM::AccessCacheBranch2(), genie::QELEventGeneratorSM::AccessCacheBranchDiffv(), genie::DISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCache::CacheBranchName(), genie::DMDISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCacheFast::CacheBranchName(), genie::QPMDISPXSec::DISRESJoinSuppressionFactor(), and genie::QPMDMDISPXSec::DMDISRESJoinSuppressionFactor().

{
  ostringstream key;

  key << k0;
  if(k1.size()>0) key << "/" << k1;
  if(k2.size()>0) key << "/" << k2;

  return key.str();
}

CacheBranchI * genie::Cache::FindCacheBranch

(

string

key

)

finding/adding cache branches

Definition at line 89 of file Cache.cxx.

References fCacheMap.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::QELEventGeneratorSM::AccessCacheBranch2(), genie::QELEventGeneratorSM::AccessCacheBranchDiffv(), genie::DISXSec::CacheFreeNucleonXSec(), genie::DMDISXSec::CacheFreeNucleonXSec(), genie::ReinSehgalRESXSecWithCache::CacheResExcitationXSec(), genie::ReinSehgalRESXSecWithCacheFast::CacheResExcitationXSec(), genie::QPMDISPXSec::DISRESJoinSuppressionFactor(), genie::QPMDMDISPXSec::DMDISRESJoinSuppressionFactor(), genie::DISXSec::Integrate(), genie::DMDISXSec::Integrate(), genie::ReinSehgalRESXSec::Integrate(), genie::ReinSehgalRESXSecFast::Integrate(), and genie::ReinSehgalSPPXSec::Integrate().

{
  map<string, CacheBranchI *>::const_iterator map_iter = fCacheMap->find(key);

  if (map_iter == fCacheMap->end()) return 0;
  return map_iter->second;
}

Cache * genie::Cache::Instance ( void  )

static

Definition at line 76 of file Cache.cxx.

References Cache(), genie::Cache::Cleaner::DummyMethodAndSilentCompiler(), fCacheMap, and fInstance.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::QELEventGeneratorSM::AccessCacheBranch2(), genie::QELEventGeneratorSM::AccessCacheBranchDiffv(), genie::DISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCache::CacheBranchName(), genie::DMDISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCacheFast::CacheBranchName(), genie::utils::app_init::CacheFile(), genie::DISXSec::CacheFreeNucleonXSec(), genie::DMDISXSec::CacheFreeNucleonXSec(), genie::ReinSehgalRESXSecWithCache::CacheResExcitationXSec(), genie::ReinSehgalRESXSecWithCacheFast::CacheResExcitationXSec(), genie::QPMDISPXSec::DISRESJoinSuppressionFactor(), genie::QPMDMDISPXSec::DMDISRESJoinSuppressionFactor(), genie::DISXSec::Integrate(), genie::DMDISXSec::Integrate(), genie::ReinSehgalRESXSec::Integrate(), genie::ReinSehgalRESXSecFast::Integrate(), genie::ReinSehgalSPPXSec::Integrate(), genie::QPMDISPXSec::LoadConfig(), and genie::QPMDMDISPXSec::LoadConfig().

{
  if(fInstance == 0) {
    static Cache::Cleaner cleaner;
    cleaner.DummyMethodAndSilentCompiler();

    fInstance = new Cache;

    fInstance->fCacheMap = new map<string, CacheBranchI * >;
  }
  return fInstance;
}

void genie::Cache::Load ( void  )

private

load/save

Definition at line 142 of file Cache.cxx.

References fCacheFile, fCacheMap, findDuplicateFiles::key, LOG, pNOTICE, and string.

Referenced by OpenCacheFile().

{
  LOG("Cache", pNOTICE) << "Loading cache";

  if(!fCacheFile) return;
  TList * keys = (TList*) fCacheFile->Get("key_list");
  TIter kiter(keys);
  TObjString * keyobj = 0;
  int ib=0;
  while ((keyobj = (TObjString *)kiter.Next())) {
    string key = string(keyobj->GetString().Data());
    ostringstream bname;
    bname << "buffer_" << ib++;
    CacheBranchI * buffer = (CacheBranchI*) fCacheFile->Get(bname.str().c_str());
    if(buffer) {
     fCacheMap->insert( map<string, CacheBranchI *>::value_type(key,buffer) );
    }
  }
  LOG("Cache", pNOTICE) << "Cache loaded...";
  LOG("Cache", pNOTICE) << *this;
}

void genie::Cache::OpenCacheFile

(

string

filename

)

cache file

Definition at line 192 of file Cache.cxx.

References fCacheFile, shutoffs::filename, Load(), LOG, pNOTICE, and pWARN.

Referenced by genie::utils::app_init::CacheFile().

{
  if(filename.size() == 0) return;

  if(fCacheFile) {
    if(fCacheFile->IsOpen()) {
       delete fCacheFile;
       fCacheFile = 0;
    }
  }

  LOG("Cache", pNOTICE) << "Using cache file: " << filename;

  fCacheFile = new TFile(filename.c_str(),"update");
  if(!fCacheFile->IsOpen()) {
     delete fCacheFile;
     fCacheFile = 0;
     LOG("Cache", pWARN) << "Could not open cache file: " << filename;
  }

  this->Load();
}

void genie::Cache::Print

(

ostream &

stream

)

const

print cache buffers

Definition at line 215 of file Cache.cxx.

References compare_h5_caf::branch, fCacheMap, and findDuplicateFiles::key.

Referenced by genie::operator<<().

{
  stream << "\n [-] GENIE Cache Buffers:";
  stream << "\n  |";
  map<string, CacheBranchI * >::iterator citer;
  for(citer = fCacheMap->begin(); citer != fCacheMap->end(); ++citer) {
    string key = citer->first;
    CacheBranchI * branch = citer->second;
    stream << "\n  |--o  " << key;
    if(!branch) {
      stream << " *** NULL *** ";
    }
  }
  stream << "\n";
}

void genie::Cache::RmAllCacheBranches

(

void

)

Definition at line 119 of file Cache.cxx.

References compare_h5_caf::branch, fCacheMap, LOG, and pNOTICE.

{
  LOG("Cache", pNOTICE) << "Removing cache branches";

  if(fCacheMap) {
    map<string, CacheBranchI * >::iterator citer;
    for(citer = fCacheMap->begin(); citer != fCacheMap->end(); ++citer) {
      CacheBranchI * branch = citer->second;
      if(branch) {
        delete branch;
        branch = 0;
      }
    }
    fCacheMap->clear();
  }
}

void genie::Cache::RmCacheBranch

(

string

key

)

removing cache branches

Definition at line 113 of file Cache.cxx.

References findDuplicateFiles::key, LOG, and pNOTICE.

{
  LOG("Cache", pNOTICE) << "Removing cache branch: " << key;

}

void genie::Cache::RmMatchedCacheBranches

(

string

key_substring

)

Definition at line 136 of file Cache.cxx.

References LOG, and pNOTICE.

Referenced by genie::QPMDISPXSec::LoadConfig(), and genie::QPMDMDISPXSec::LoadConfig().

{
  LOG("Cache", pNOTICE) << "Removing cache branches: *"<< key_substring<< "*";

}

void genie::Cache::Save ( void  )

private

Definition at line 164 of file Cache.cxx.

References compare_h5_caf::branch, fCacheFile, fCacheMap, and findDuplicateFiles::key.

Referenced by ~Cache().

{
  if(!fCacheFile) {
    return;
  }
  fCacheFile->cd();

  int ib=0;
  TList * keys = new TList;
  keys->SetOwner(true);

  map<string, CacheBranchI * >::iterator citer;
  for(citer = fCacheMap->begin(); citer != fCacheMap->end(); ++citer) {
    string key = citer->first;
    CacheBranchI * branch = citer->second;
    if(branch) {
      ostringstream bname;
      bname << "buffer_" << ib++;
      keys->Add(new TObjString(key.c_str()));
      branch->Write(bname.str().c_str(), TObject::kOverwrite);
    }
  }
  keys->Write("key_list", TObject::kSingleKey | TObject::kOverwrite );

  keys->Clear();
  delete keys;
}

Friends And Related Function Documentation

friend struct Cleaner

friend

Definition at line 90 of file Cache.h.

ostream& operator<< ( ostream &  stream, const Cache &  cache  )

friend

Definition at line 38 of file Cache.cxx.

{
  cache.Print(stream);
  return stream;
}

Member Data Documentation

TFile* genie::Cache::fCacheFile

private

Definition at line 73 of file Cache.h.

Referenced by Cache(), Load(), OpenCacheFile(), Save(), and ~Cache().

map<string, CacheBranchI * >* genie::Cache::fCacheMap

private

map of cache buffers & cache file

Definition at line 72 of file Cache.h.

Referenced by AddCacheBranch(), Cache(), FindCacheBranch(), Instance(), Load(), Print(), RmAllCacheBranches(), Save(), and ~Cache().

Cache * genie::Cache::fInstance = 0

staticprivate

singleton instance

Definition at line 69 of file Cache.h.

Referenced by Cache(), Instance(), genie::operator<<(), ~Cache(), and genie::Cache::Cleaner::~Cleaner().

---

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

• Framework/Utils/Cache.h
• Framework/Utils/Cache.cxx