Base class to loop over all the keys in a ROOT file. More...

#include <TFileLooper.h>

Inheritance diagram for TFileLooper:

Collaboration diagram for TFileLooper:

Public Member Functions
	TFileLooper ()=default

virtual	~TFileLooper ()=default

	TFileLooper (const TFileLooper &other)=delete

TFileLooper &	operator= (const TFileLooper &other)=delete

virtual Int_t	run (const char filename, const char rootDir=0)
	Start processing. More...

virtual void	processKey (TDirectory &dir, TKey &key)
	Method called for every key. More...

Processing hooks
TFile *	m_file {nullptr}

TString	m_rootDir

TString	m_skipDirs

Bool_t	m_verbose {kFALSE}

Bool_t	m_passBeforeFail {kFALSE}

Int_t	m_errorCode {0}

std::vector< TPRegexp >	m_failRE

std::vector< TPRegexp >	m_passRE

std::vector< std::string >	m_skippedObjects

virtual void	beginJob ()

virtual void	endJob ()

virtual void	beforeFile ()

virtual void	afterFile ()

virtual void	beforeDir ()

virtual void	afterDir ()

virtual void	beforeObj ()

virtual void	afterObj ()

void	setDirsToSkip (const char *skipDirs)
	Skip this comma separated list of directories. More...

void	addFailRegexp (const char *regexp)
	Skip keys that match this regexp. More...

void	addPassRegexp (const char *regexp)
	Never skip keys that match this regexp. More...

void	passBeforeFailRegexp (Bool_t passBeforeFail=kTRUE)
	Reverse pass/fail logic. First check on pass then on fail. More...

void	setVerbose (Bool_t verbose=kTRUE)
	Set verbose mode. More...

Bool_t	verbose () const
	Query verbose mode. More...

const TFile *	file () const
	Current ROOT file. More...

TString	rootDir () const
	Current directory. More...

TString	getPathFromDir (const TDirectory &dir)

TString	getKeyPath (const TDirectory &dir, const TKey &key)

void	processDir (TDirectory &dir)

void	processFile (const char filename, const char rootDir=0)

Bool_t	skipDir (const TDirectory &dir)

Bool_t	skipObject (const char *name)

TString	getDrawOptions (const TH1 &h)

Detailed Description

Base class to loop over all the keys in a ROOT file.

Author: Frank Winklmeier

Loop over all the keys in a given ROOT file. Apply regular expressions to the keys to relevant keys. The action for each key needs to be implemented in a derived class.

Definition at line 35 of file TFileLooper.h.

Constructor & Destructor Documentation

◆ TFileLooper() [1/2]

TFileLooper::TFileLooper ( )

default

◆ ~TFileLooper()

virtual TFileLooper::~TFileLooper ( )

virtualdefault

◆ TFileLooper() [2/2]

TFileLooper::TFileLooper ( const TFileLooper & other )

delete

Member Function Documentation

◆ addFailRegexp()

void TFileLooper::addFailRegexp ( const char * regexp )

Skip keys that match this regexp.

Definition at line 160 of file TFileLooper.cxx.

 {
   if (regexp) {
     m_failRE.emplace_back(regexp);
   }
 }

◆ addPassRegexp()

void TFileLooper::addPassRegexp ( const char * regexp )

Never skip keys that match this regexp.

Definition at line 169 of file TFileLooper.cxx.

 {
   if (regexp) {
     m_passRE.emplace_back(regexp);
   }
 }

◆ afterDir()

virtual void TFileLooper::afterDir ( )

inlinevirtual

Definition at line 59 of file TFileLooper.h.

59 {}

◆ afterFile()

virtual void TFileLooper::afterFile ( )

inlinevirtual

Definition at line 57 of file TFileLooper.h.

57 {}

◆ afterObj()

virtual void TFileLooper::afterObj ( )

inlinevirtual

Definition at line 61 of file TFileLooper.h.

61 {}

◆ beforeDir()

virtual void TFileLooper::beforeDir ( )

inlinevirtual

Definition at line 58 of file TFileLooper.h.

58 {}

◆ beforeFile()

virtual void TFileLooper::beforeFile ( )

inlinevirtual

Definition at line 56 of file TFileLooper.h.

56 {}

◆ beforeObj()

virtual void TFileLooper::beforeObj ( )

inlinevirtual

Definition at line 60 of file TFileLooper.h.

60 {}

◆ beginJob()

virtual void TFileLooper::beginJob ( )

inlinevirtual

Reimplemented in TRootCompare.

Definition at line 54 of file TFileLooper.h.

54 {}

◆ endJob()

virtual void TFileLooper::endJob ( )

inlinevirtual

Reimplemented in TRootCompare.

Definition at line 55 of file TFileLooper.h.

55 {}

◆ file()

const TFile* TFileLooper::file ( ) const

inline

Current ROOT file.

Definition at line 83 of file TFileLooper.h.

83 { return m_file; }

◆ getDrawOptions()

TString TFileLooper::getDrawOptions ( const TH1 & h )

protected

◆ getKeyPath()

TString TFileLooper::getKeyPath	(	const TDirectory &	dir,
		const TKey &	key
	)

protected

Definition at line 188 of file TFileLooper.cxx.

 {
   TString s(dir.GetPath()+TString("/")+key.GetName());
   // Remove all chars from beginning including ":/"
   s.Replace(0,s.First(":")+2,0);
  
   return s;
 }

◆ getPathFromDir()

TString TFileLooper::getPathFromDir ( const TDirectory & dir )

protected

Definition at line 178 of file TFileLooper.cxx.

 {
   TString s(dir.GetPath());
   if (s.Index("../")==0) s.Remove(0,3);
   s.ReplaceAll(":","");
   return s;
 }

◆ operator=()

TFileLooper& TFileLooper::operator= ( const TFileLooper & other )

delete

◆ passBeforeFailRegexp()

void TFileLooper::passBeforeFailRegexp ( Bool_t passBeforeFail = kTRUE )

inline

Reverse pass/fail logic. First check on pass then on fail.

Definition at line 74 of file TFileLooper.h.

74 { m_passBeforeFail = passBeforeFail; }

◆ processDir()

void TFileLooper::processDir ( TDirectory & dir )

protected

Definition at line 73 of file TFileLooper.cxx.

 {
   TString s(getPathFromDir(dir));
  
   if (skipDir(dir)) {
     cout << "Skipping " << s << endl;
     return;
   }
  
   if (m_verbose) cout << "Reading directory "<< dir.GetPath() << endl;
         
   // Sort directory content
   TList* dirList = dir.GetListOfKeys();
   dirList->Sort();
  
   TIter next(dirList);
   TKey* key;
   while ((key = (TKey*)next())) {
     //    if (skipObject(getKeyPath(dir,*key))) continue;
  
     TString className(key->GetClassName());
     if (className=="TDirectoryFile" || className=="TDirectory") {
       dir.cd(key->GetName());
       beforeDir();      
       processDir(*gDirectory);
       afterDir();
     }
     else {
       if (skipObject(getKeyPath(dir,*key))) {
         m_skippedObjects.push_back(getKeyPath(dir,*key).Data());
         continue;
       }
       processKey(dir, *key);
     }
   }
 }

◆ processFile()

void TFileLooper::processFile	(	const char *	filename,
		const char *	rootDir = `0`
	)

protected

Definition at line 44 of file TFileLooper.cxx.

 {    
   m_file = new TFile(filename);
   if (m_file->IsZombie()) {
     cout << "Cannot open "<<filename << endl;
     m_errorCode = 1;
     delete m_file;    
     return;
   }
  
   if (rootDir) {
     if (!m_file->cd(rootDir)) {
       cout << "Cannot change to directory " << rootDir << endl;
       m_errorCode = 1;
       return;
     }
     m_rootDir = rootDir;
   }
   else m_file->cd();
   
   beforeFile();
   processDir(*gDirectory);
   afterFile();
   
   delete m_file;   // calls Close()
 }

◆ processKey()

void TFileLooper::processKey	(	TDirectory &	dir,
		TKey &	key
	)

virtual

Method called for every key.

Only dummy implementation. Needs to be implemented in derived classes.

Reimplemented in TRootCompare.

Definition at line 110 of file TFileLooper.cxx.

 {
   cout << "--- processKey: " << key.GetName()
        << " in directory " << dir.GetPath() << endl;
 }

◆ rootDir()

TString TFileLooper::rootDir ( ) const

inline

Current directory.

Definition at line 86 of file TFileLooper.h.

86 { return m_rootDir; }

◆ run()

Int_t TFileLooper::run	(	const char *	filename,
		const char *	rootDir = `0`
	)

virtual

Start processing.

Reimplemented in TMultiFileLooper.

Definition at line 26 of file TFileLooper.cxx.

 {
   m_errorCode = 0;
  
   if (filename==0) {
     cout << "Invalid file name (0)" << endl;
     m_errorCode = 1;
     return m_errorCode;
   }
     
   beginJob();  
   processFile(filename,rootDir);
   endJob();
   return m_errorCode;
 }

◆ setDirsToSkip()

void TFileLooper::setDirsToSkip ( const char * skipDirs )

inline

Skip this comma separated list of directories.

Definition at line 65 of file TFileLooper.h.

65 {if (skipDirs) m_skipDirs = skipDirs;}

◆ setVerbose()

void TFileLooper::setVerbose ( Bool_t verbose = kTRUE )

inline

Set verbose mode.

Definition at line 77 of file TFileLooper.h.

77 {m_verbose = verbose;}

◆ skipDir()

Bool_t TFileLooper::skipDir ( const TDirectory & dir )

protected

Definition at line 118 of file TFileLooper.cxx.

 {
   if (m_skipDirs.Contains(dir.GetName())) return kTRUE;
   else return kFALSE;
 }

◆ skipObject()

Bool_t TFileLooper::skipObject ( const char * name )

protected

Definition at line 129 of file TFileLooper.cxx.

 {
   Bool_t failMatch(kFALSE);
   Bool_t passMatch(kFALSE);
   
   for (auto& re : m_failRE) {
     if (re.Match(name)>0) {
       failMatch = kTRUE;
       break;
     }
   }
  
   // give object another chance to match any of the m_passRE
   for (auto& re : m_passRE) {
     if (re.Match(name)>0) {
       passMatch = kTRUE;
       break;
     }
   }
  
   bool result;
   if (m_passBeforeFail) result = (!passMatch || failMatch);
   else result = (failMatch && !passMatch);
  
   if (m_verbose && result) cout << "Skipping " << name << endl;
   return result;
     
 }

◆ verbose()

Bool_t TFileLooper::verbose ( ) const

inline

Query verbose mode.

Definition at line 80 of file TFileLooper.h.

80 {return m_verbose;}

Member Data Documentation

◆ m_errorCode

Int_t TFileLooper::m_errorCode {0}

protected

Definition at line 94 of file TFileLooper.h.

◆ m_failRE

std::vector<TPRegexp> TFileLooper::m_failRE

protected

Definition at line 96 of file TFileLooper.h.

◆ m_file

TFile* TFileLooper::m_file {nullptr}

protected

Definition at line 89 of file TFileLooper.h.

◆ m_passBeforeFail

Bool_t TFileLooper::m_passBeforeFail {kFALSE}

protected

Definition at line 93 of file TFileLooper.h.

◆ m_passRE

std::vector<TPRegexp> TFileLooper::m_passRE

protected

Definition at line 97 of file TFileLooper.h.

◆ m_rootDir

TString TFileLooper::m_rootDir

protected

Definition at line 90 of file TFileLooper.h.

◆ m_skipDirs

TString TFileLooper::m_skipDirs

protected

Definition at line 91 of file TFileLooper.h.

◆ m_skippedObjects

std::vector<std::string> TFileLooper::m_skippedObjects

protected

Definition at line 99 of file TFileLooper.h.

◆ m_verbose

Bool_t TFileLooper::m_verbose {kFALSE}

protected

Definition at line 92 of file TFileLooper.h.

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

Public Member Functions

Processing hooks

Detailed Description

Constructor & Destructor Documentation

◆ TFileLooper() [1/2]

◆ ~TFileLooper()

◆ TFileLooper() [2/2]

Member Function Documentation

◆ addFailRegexp()

◆ addPassRegexp()

◆ afterDir()

◆ afterFile()

◆ afterObj()

◆ beforeDir()

◆ beforeFile()

◆ beforeObj()

◆ beginJob()

◆ endJob()

◆ file()

◆ getDrawOptions()

◆ getKeyPath()

◆ getPathFromDir()

◆ operator=()

◆ passBeforeFailRegexp()

◆ processDir()

◆ processFile()

◆ processKey()

◆ rootDir()

◆ run()

◆ setDirsToSkip()

◆ setVerbose()

◆ skipDir()

◆ skipObject()

◆ verbose()

Member Data Documentation

◆ m_errorCode

◆ m_failRE

◆ m_file

◆ m_passBeforeFail

◆ m_passRE

◆ m_rootDir

◆ m_skipDirs

◆ m_skippedObjects

◆ m_verbose