EL::DuplicateChecker Class Reference

#include <DuplicateChecker.h>

Inheritance diagram for EL::DuplicateChecker:

List of all members.

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	DuplicateChecker ()
	standard constructor
const std::string &	eventInfoName () const
	the name of the EventInfo structure to use
void	setEventInfoName (const std::string &val_eventInfoName)
	set the value of eventInfoName
const std::string &	outputTreeName () const
	the name of the output tree to create, or the empty string if none is created
void	setOutputTreeName (const std::string &val_outputTreeName)
	set the value of outputTreeName
void	addKnownDuplicate (const std::string &sampleName, const std::string &fileName, Long64_t entry, number_type runNumber, number_type eventNumber)
	add a known duplicate event
void	addKnownDuplicatesFile (const std::string &duplicatesFile)
	add a file with known duplicates
Static Public Member Functions
static bool	processSummary (const std::string &submitdir, const std::string &treeName)
	process the summary tree from the given submission
static bool	processSummary (const SH::SampleHandler &sh, const std::string &outputFile)

---

Detailed Description

Todo:

add documentation

---

Constructor & Destructor Documentation

EL::DuplicateChecker::DuplicateChecker

(

)

standard constructor

Guarantee

strong

Failures

out of memory I

---

Member Function Documentation

void EL::DuplicateChecker::addKnownDuplicate	(	const std::string &	sampleName,
		const std::string &	fileName,
		Long64_t	entry,
		number_type	runNumber,
		number_type	eventNumber
	)

add a known duplicate event

Guarantee

strong

Failures

out of memory II

void EL::DuplicateChecker::addKnownDuplicatesFile

(

const std::string &

duplicatesFile

)

add a file with known duplicates

Guarantee

strong

Failures

i/o errors
out of memory III

const std::string& EL::DuplicateChecker::eventInfoName

(

)

const

the name of the EventInfo structure to use

This is mostly meant, so that in my unit test code I can point it to my own specially prepared EventInfo

Guarantee

no-fail

const std::string& EL::DuplicateChecker::outputTreeName

(

)

const

the name of the output tree to create, or the empty string if none is created

The output tree contains a list of run and event numbers for all events, and whether they were processed by this job. This can be used to check whether duplicate events were processed (or whether we somehow eliminated events as duplicates that we shouldn't have). It can also be used to create a list of duplicate events for future processing rounds.

static bool EL::DuplicateChecker::processSummary	(	const SH::SampleHandler &	sh,
		const std::string &	outputFile
	)			[static]

process the summary tree from the given submission This will create a file "duplicates" inside the submission directory that contains the list of duplicates that can be fed into future submissions to filter them out.

Returns:

whether the job was successfully, i.e. each input event was read exactly once and all duplicates were skipped

Guarantee

basic

Failures

i/o errors

This version of the method provides a lower level interface, in which the list of inputs is given via a sample handler (with the tree name properly set), and the output file name freely choosable.

static bool EL::DuplicateChecker::processSummary	(	const std::string &	submitdir,
		const std::string &	treeName
	)			[static]

process the summary tree from the given submission

This will create a file "duplicates" inside the submission directory that contains the list of duplicates that can be fed into future submissions to filter them out.

Returns:

whether the job was successfully, i.e. each input event was read exactly once and all duplicates were skipped

Guarantee

basic

Failures

i/o errors

void EL::DuplicateChecker::setEventInfoName

(

const std::string &

val_eventInfoName

)

set the value of eventInfoName

Guarantee

strong

Failures

out of memory II

void EL::DuplicateChecker::setOutputTreeName

(

const std::string &

val_outputTreeName

)

set the value of outputTreeName

Guarantee

strong

Failures

out of memory II

void EL::DuplicateChecker::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Reimplemented from EL::Algorithm.

---

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

• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/EventLoopAlgs/EventLoopAlgs/DuplicateChecker.h