art::DuplicateChecker Class Reference

#include "DuplicateChecker.h"

Classes
struct	Config

Public Member Functions
	DuplicateChecker (fhicl::TableFragment< Config > const &config)
void	init (bool realData, FileIndex const &fileIndex)
void	inputFileClosed ()
void	rewind ()
bool	isDuplicateAndCheckActive (EventID const &eventID, std::string const &fileName)

Private Types
enum	DuplicateCheckMode { noDuplicateCheck, checkEachFile, checkEachRealDataFile, checkAllFilesOpened }
enum	DataType { isRealData, isSimulation, unknown }

Private Attributes
DuplicateCheckMode	duplicateCheckMode_
DataType	dataType_
std::set< EventID >	eventIDs_
bool	itIsKnownTheFileHasNoDuplicates_

Detailed Description

Definition at line 29 of file DuplicateChecker.h.

Member Enumeration Documentation

enum art::DuplicateChecker::DataType

private

Enumerator
isRealData
isSimulation
unknown

Definition at line 58 of file DuplicateChecker.h.

{ isRealData, isSimulation, unknown };

enum art::DuplicateChecker::DuplicateCheckMode

private

Enumerator
noDuplicateCheck
checkEachFile
checkEachRealDataFile
checkAllFilesOpened

Definition at line 49 of file DuplicateChecker.h.

                            {
      noDuplicateCheck,
      checkEachFile,
      checkEachRealDataFile,
      checkAllFilesOpened
    };

Constructor & Destructor Documentation

art::DuplicateChecker::DuplicateChecker

(

fhicl::TableFragment< Config > const &

config

)

Definition at line 12 of file DuplicateChecker.cc.

References checkAllFilesOpened, checkEachFile, checkEachRealDataFile, duplicateCheckMode_, and noDuplicateCheck.

    :

    duplicateCheckMode_(checkEachRealDataFile)
    , dataType_(unknown)
    , eventIDs_()
    , itIsKnownTheFileHasNoDuplicates_(false)
  {
    std::string const& duplicateCheckMode = config().duplicateCheckMode();

    if (duplicateCheckMode == std::string("noDuplicateCheck"))
      duplicateCheckMode_ = noDuplicateCheck;
    else if (duplicateCheckMode == std::string("checkEachFile"))
      duplicateCheckMode_ = checkEachFile;
    else if (duplicateCheckMode == std::string("checkEachRealDataFile"))
      duplicateCheckMode_ = checkEachRealDataFile;
    else if (duplicateCheckMode == std::string("checkAllFilesOpened"))
      duplicateCheckMode_ = checkAllFilesOpened;
    else {
      throw cet::exception("Configuration")
        << "Illegal configuration parameter value passed to RootInput for\n"
        << "the \"duplicateCheckMode\" parameter, legal values are:\n"
        << "\"noDuplicateCheck\", \"checkEachFile\", "
           "\"checkEachRealDataFile\", \"checkAllFilesOpened\"\n";
    }
  }

Member Function Documentation

void art::DuplicateChecker::init	(	bool	realData,
		FileIndex const &	fileIndex
	)

Definition at line 41 of file DuplicateChecker.cc.

References checkAllFilesOpened, checkEachFile, checkEachRealDataFile, dataType_, duplicateCheckMode_, art::FileIndex::eventsUniqueAndOrdered(), isRealData, isSimulation, itIsKnownTheFileHasNoDuplicates_, noDuplicateCheck, and unknown.

  {
    if (duplicateCheckMode_ == noDuplicateCheck)
      return;
    if (duplicateCheckMode_ == checkAllFilesOpened)
      return;

    assert(dataType_ == unknown);
    dataType_ = realData ? isRealData : isSimulation;

    if (duplicateCheckMode_ == checkEachFile ||
        (duplicateCheckMode_ == checkEachRealDataFile &&
         dataType_ == isRealData)) {
      itIsKnownTheFileHasNoDuplicates_ = fileIndex.eventsUniqueAndOrdered();
    }
  }

void art::DuplicateChecker::inputFileClosed

(

)

Definition at line 59 of file DuplicateChecker.cc.

References checkAllFilesOpened, dataType_, duplicateCheckMode_, eventIDs_, itIsKnownTheFileHasNoDuplicates_, noDuplicateCheck, and unknown.

  {
    if (duplicateCheckMode_ == noDuplicateCheck)
      return;
    if (duplicateCheckMode_ == checkAllFilesOpened)
      return;

    dataType_ = unknown;
    eventIDs_.clear();
    itIsKnownTheFileHasNoDuplicates_ = false;
  }

bool art::DuplicateChecker::isDuplicateAndCheckActive	(	EventID const &	eventID,
		std::string const &	fileName
	)

Definition at line 78 of file DuplicateChecker.cc.

References checkAllFilesOpened, checkEachFile, checkEachRealDataFile, dataType_, duplicateCheckMode_, eventIDs_, isSimulation, itIsKnownTheFileHasNoDuplicates_, noDuplicateCheck, and unknown.

  {
    if (duplicateCheckMode_ == noDuplicateCheck)
      return false;
    if (duplicateCheckMode_ == checkEachRealDataFile &&
        dataType_ == isSimulation)
      return false;

    if (duplicateCheckMode_ == checkEachFile ||
        duplicateCheckMode_ == checkEachRealDataFile) {
      assert(dataType_ != unknown);
      if (itIsKnownTheFileHasNoDuplicates_)
        return false;
    }

    bool duplicate = !eventIDs_.insert(eventID).second;

    if (duplicate) {
      if (duplicateCheckMode_ == checkAllFilesOpened) {
        LogWarning("DuplicateEvent")
          << "Duplicate Events found in entire set of input files.\n"
          << "Both events were from " << eventID << ".\n"
          << "The duplicate was from file " << fileName << ".\n"
          << "The duplicate will be skipped.\n";
      } else {
        LogWarning("DuplicateEvent")
          << "Duplicate Events found in file " << fileName << ".\n"
          << "Both events were " << eventID << ".\n"
          << "The duplicate will be skipped.\n";
      }
      return true;
    }
    return false;
  }

void art::DuplicateChecker::rewind

(

)

Definition at line 72 of file DuplicateChecker.cc.

References eventIDs_.

  {
    eventIDs_.clear();
  }

Member Data Documentation

DataType art::DuplicateChecker::dataType_

private

Definition at line 60 of file DuplicateChecker.h.

Referenced by init(), inputFileClosed(), and isDuplicateAndCheckActive().

DuplicateCheckMode art::DuplicateChecker::duplicateCheckMode_

private

Definition at line 56 of file DuplicateChecker.h.

Referenced by DuplicateChecker(), init(), inputFileClosed(), and isDuplicateAndCheckActive().

std::set<EventID> art::DuplicateChecker::eventIDs_

private

Definition at line 62 of file DuplicateChecker.h.

Referenced by inputFileClosed(), isDuplicateAndCheckActive(), and rewind().

bool art::DuplicateChecker::itIsKnownTheFileHasNoDuplicates_

private

Definition at line 64 of file DuplicateChecker.h.

Referenced by init(), inputFileClosed(), and isDuplicateAndCheckActive().

---

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

• art/Framework/IO/Root/DuplicateChecker.h
• art/Framework/IO/Root/DuplicateChecker.cc