ProgressReporter Class Reference

This class is used to report progress of various codes that run over every event in a file. More...

#include <ProgressReporter.h>

Inheritance diagram for ProgressReporter:

Public Member Functions
	ProgressReporter ()
virtual	~ProgressReporter ()
void	SetReportFrequency (Long64_t freq)
	Sets the frequency of reporting progress to terminal. More...

Protected Member Functions
void	ReportProgress (Long64_t entry)
	Sends report to the terminal if needed. More...
void	SetNumberOfEntries (Long64_t nentries)
	Sets the number of entries to process. More...
Long64_t	SetNumberOfEntries (TTree *tree)
	Sets the number of entries to process from a tree. More...
void	SetReportFile (TString name)
	Sets the name of the file to report to the terminal. More...

Protected Attributes
Long64_t	fNumberOfEntries = 0
	Number of entries being run over. More...

Private Attributes
TString	fReportFile = ""
	Name of the file being run on. More...
Long64_t	fReportFreq = 100000
	Number of events between each frequency report. More...

Detailed Description

This class is used to report progress of various codes that run over every event in a file.

Definition at line 20 of file ProgressReporter.h.

Constructor & Destructor Documentation

ProgressReporter()

ProgressReporter::ProgressReporter ( )

inline

Definition at line 23 of file ProgressReporter.h.

~ProgressReporter()

virtual ProgressReporter::~ProgressReporter ( )

inlinevirtual

Definition at line 24 of file ProgressReporter.h.

Member Function Documentation

ReportProgress()

void ProgressReporter::ReportProgress ( Long64_t  entry )

inlineprotected

Sends report to the terminal if needed.

Definition at line 39 of file ProgressReporter.h.

References fNumberOfEntries, fReportFile, and fReportFreq.

Referenced by CorrectorApplicator::ApplyCorrections(), and FlatSkimmer::Skim().

SetNumberOfEntries() [1/2]

void ProgressReporter::SetNumberOfEntries ( Long64_t  nentries )

inlineprotected

Sets the number of entries to process.

Definition at line 31 of file ProgressReporter.h.

References fNumberOfEntries.

Referenced by CorrectorApplicator::ApplyCorrections(), and FlatSkimmer::Skim().

SetNumberOfEntries() [2/2]

Long64_t ProgressReporter::SetNumberOfEntries ( TTree *  tree )

inlineprotected

Sets the number of entries to process from a tree.

Definition at line 33 of file ProgressReporter.h.

References fNumberOfEntries.

SetReportFile()

void ProgressReporter::SetReportFile ( TString  name )

inlineprotected

Sets the name of the file to report to the terminal.

Definition at line 36 of file ProgressReporter.h.

References fReportFile.

Referenced by CorrectorApplicator::ApplyCorrections(), and FlatSkimmer::Skim().

SetReportFrequency()

void ProgressReporter::SetReportFrequency ( Long64_t  freq )

inline

Sets the frequency of reporting progress to terminal.

Definition at line 27 of file ProgressReporter.h.

References fReportFreq.

Member Data Documentation

fNumberOfEntries

Long64_t ProgressReporter::fNumberOfEntries = 0

protected

Number of entries being run over.

Definition at line 44 of file ProgressReporter.h.

Referenced by ReportProgress(), and SetNumberOfEntries().

fReportFile

TString ProgressReporter::fReportFile = ""

private

Name of the file being run on.

Definition at line 48 of file ProgressReporter.h.

Referenced by ReportProgress(), and SetReportFile().

fReportFreq

Long64_t ProgressReporter::fReportFreq = 100000

private

Number of events between each frequency report.

Definition at line 47 of file ProgressReporter.h.

Referenced by ReportProgress(), and SetReportFrequency().

---

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

• ProgressReporter.h