art::FileStatsCollector Class Reference

#include "FileStatsCollector.h"

Public Member Functions
	FileStatsCollector (std::string const &moduleLabel, std::string const &processName)
void	recordFileOpen ()
void	recordInputFile (std::string const &inputFileName)
void	recordEvent (EventID const &id)
void	recordRun (RunID const &id)
void	recordSubRun (SubRunID const &id)
void	recordFileClose ()
std::string const &	moduleLabel () const
std::string const &	processName () const
boost::posix_time::ptime	outputFileOpenTime () const
boost::posix_time::ptime	outputFileCloseTime () const
SubRunID const &	lowestSubRunID () const
SubRunID const &	highestSubRunID () const
EventID const &	lowestEventID () const
EventID const &	highestEventID () const
std::string const &	lastOpenedInputFile () const
std::vector< std::string >	parents (bool want_basename=true) const
bool	fileCloseRecorded () const
std::size_t	eventsThisFile () const
std::set< SubRunID > const &	seenSubRuns () const

Private Member Functions
void	resetStatistics_ ()

Private Attributes
std::string const	moduleLabel_
std::string const	processName_
SubRunID	lowestSubRun_ {}
SubRunID	highestSubRun_ {}
EventID	lowestEventIDSeen_ {}
EventID	highestEventIDSeen_ {}
boost::posix_time::ptime	fo_ {}
boost::posix_time::ptime	fc_ {}
bool	fileCloseRecorded_ {false}
std::string	lastOpenedInputFile_ {}
std::vector< std::string >	inputFilesSeen_ {}
std::size_t	nEvents_ {}
std::set< SubRunID >	subRunsSeen_ {}

Detailed Description

Definition at line 22 of file FileStatsCollector.h.

Constructor & Destructor Documentation

art::FileStatsCollector::FileStatsCollector	(	std::string const &	moduleLabel,
		std::string const &	processName
	)

Definition at line 7 of file FileStatsCollector.cc.

References processName(), and processName_.

  : moduleLabel_{moduleLabel}, processName_{processName}
{}

Member Function Documentation

std::size_t art::FileStatsCollector::eventsThisFile ( ) const

inline

Definition at line 127 of file FileStatsCollector.h.

References nEvents_.

Referenced by art::RootOutputFile::writeFileCatalogMetadata().

{
  return nEvents_;
}

bool art::FileStatsCollector::fileCloseRecorded ( ) const

inline

Definition at line 121 of file FileStatsCollector.h.

References fileCloseRecorded_.

Referenced by art::PostCloseFileRenamer::applySubstitutions().

{
  return fileCloseRecorded_;
}

art::EventID const & art::FileStatsCollector::highestEventID ( ) const

inline

Definition at line 109 of file FileStatsCollector.h.

References highestEventIDSeen_.

Referenced by art::RootOutputFile::writeFileCatalogMetadata().

{
  return highestEventIDSeen_;
}

art::SubRunID const & art::FileStatsCollector::highestSubRunID ( ) const

inline

Definition at line 97 of file FileStatsCollector.h.

References highestSubRun_.

Referenced by art::PostCloseFileRenamer::subFilledNumericNoIndex_().

{
  return highestSubRun_;
}

std::string const & art::FileStatsCollector::lastOpenedInputFile ( ) const

inline

Definition at line 115 of file FileStatsCollector.h.

References lastOpenedInputFile_.

Referenced by art::PostCloseFileRenamer::subInputFileName_().

{
  return lastOpenedInputFile_;
}

art::EventID const & art::FileStatsCollector::lowestEventID ( ) const

inline

Definition at line 103 of file FileStatsCollector.h.

References lowestEventIDSeen_.

Referenced by art::RootOutputFile::writeFileCatalogMetadata().

{
  return lowestEventIDSeen_;
}

art::SubRunID const & art::FileStatsCollector::lowestSubRunID ( ) const

inline

Definition at line 91 of file FileStatsCollector.h.

References lowestSubRun_.

Referenced by art::PostCloseFileRenamer::subFilledNumericNoIndex_().

{
  return lowestSubRun_;
}

std::string const & art::FileStatsCollector::moduleLabel ( ) const

inline

Definition at line 67 of file FileStatsCollector.h.

References moduleLabel_.

Referenced by art::PostCloseFileRenamer::applySubstitutionsNoIndex_().

{
  return moduleLabel_;
}

boost::posix_time::ptime art::FileStatsCollector::outputFileCloseTime ( ) const

inline

Definition at line 85 of file FileStatsCollector.h.

References fc_.

Referenced by art::PostCloseFileRenamer::subTimestamp_().

{
  return fc_;
}

boost::posix_time::ptime art::FileStatsCollector::outputFileOpenTime ( ) const

inline

Definition at line 79 of file FileStatsCollector.h.

References fo_.

Referenced by art::PostCloseFileRenamer::subTimestamp_(), and art::RootOutputFile::writeFileCatalogMetadata().

{
  return fo_;
}

std::vector< std::string > art::FileStatsCollector::parents

(

bool

want_basename = true

)

const

Definition at line 85 of file FileStatsCollector.cc.

References inputFilesSeen_.

Referenced by art::RootOutputFile::writeFileCatalogMetadata().

{
  std::vector<std::string> result;
  if (want_basename) {
    result.reserve(inputFilesSeen_.size());
    for (auto const& ifile : inputFilesSeen_) {
      boost::filesystem::path const ifp{ifile};
      result.emplace_back(ifp.filename().native());
    }
  } else {
    result = inputFilesSeen_;
  }
  return result;
}

std::string const & art::FileStatsCollector::processName ( ) const

inline

Definition at line 73 of file FileStatsCollector.h.

References processName_.

Referenced by art::PostCloseFileRenamer::applySubstitutionsNoIndex_(), and FileStatsCollector().

{
  return processName_;
}

void art::FileStatsCollector::recordEvent

(

EventID const &

id

)

Definition at line 33 of file FileStatsCollector.cc.

References highestEventIDSeen_, art::EventID::isValid(), lowestEventIDSeen_, nEvents_, and recordSubRun().

Referenced by art::TFileService::TFileService(), and art::RootOutput::write().

{
  ++nEvents_;
  // Actually saw a real event that we've been asked to write, so
  // EventID should be valid.
  if (!lowestEventIDSeen_.isValid() || id < lowestEventIDSeen_) {
    lowestEventIDSeen_ = id;
  }
  if (id > highestEventIDSeen_) {
    // Sort-invalid-first gives the correct answer.
    highestEventIDSeen_ = id;
  }
  // Record that we have seen this SubRunID too.
  recordSubRun(id.subRunID());
}

void art::FileStatsCollector::recordFileClose

(

)

Definition at line 78 of file FileStatsCollector.cc.

References fc_, and fileCloseRecorded_.

Referenced by art::TFileService::closeFile_(), and art::RootOutput::finishEndFile().

{
  fc_ = boost::posix_time::second_clock::universal_time();
  fileCloseRecorded_ = true;
}

void art::FileStatsCollector::recordFileOpen

(

)

Definition at line 13 of file FileStatsCollector.cc.

References fileCloseRecorded_, fo_, inputFilesSeen_, lastOpenedInputFile_, and resetStatistics_().

Referenced by art::RootOutput::doOpenFile(), and art::TFileService::openFile_().

{
  resetStatistics_();
  if (!inputFilesSeen_.empty()) {
    inputFilesSeen_.emplace_back(lastOpenedInputFile_);
  }
  fo_ = boost::posix_time::second_clock::universal_time();
  fileCloseRecorded_ = false;
}

void art::FileStatsCollector::recordInputFile

(

std::string const &

inputFileName

)

Definition at line 24 of file FileStatsCollector.cc.

References inputFilesSeen_, and lastOpenedInputFile_.

Referenced by art::RootOutput::respondToOpenInputFile(), and art::TFileService::TFileService().

{
  if (!inputFileName.empty()) {
    inputFilesSeen_.emplace_back(inputFileName);
  }
  lastOpenedInputFile_ = inputFileName;
}

void art::FileStatsCollector::recordRun

(

RunID const &

id

)

Definition at line 50 of file FileStatsCollector.cc.

References highestSubRun_, art::SubRunID::invalidSubRun(), art::RunID::isValid(), lowestSubRun_, and art::SubRunID::runID().

Referenced by recordSubRun(), art::TFileService::TFileService(), and art::RootOutput::writeRun().

{
  if ((!lowestSubRun_.runID().isValid()) || id < lowestSubRun_.runID()) {
    lowestSubRun_ = SubRunID::invalidSubRun(id);
  }
  if (id > highestSubRun_.runID()) {
    // Sort-invalid-first gives the correct answer.
    highestSubRun_ = SubRunID::invalidSubRun(id);
  }
}

void art::FileStatsCollector::recordSubRun

(

SubRunID const &

id

)

Definition at line 62 of file FileStatsCollector.cc.

References highestSubRun_, art::SubRunID::isValid(), lowestSubRun_, recordRun(), art::SubRunID::runID(), and subRunsSeen_.

Referenced by recordEvent(), art::TFileService::TFileService(), and art::RootOutput::writeSubRun().

{
  recordRun(id.runID());
  if (id.runID() == lowestSubRun_.runID() &&
      (id.isValid() && ((!lowestSubRun_.isValid()) || // No valid subrun yet.
                        id < lowestSubRun_))) {
    lowestSubRun_ = id;
  }
  if (id > highestSubRun_) {
    // Sort-invalid-first gives the correct answer.
    highestSubRun_ = id;
  }
  subRunsSeen_.emplace(id);
}

void art::FileStatsCollector::resetStatistics_ ( )

private

Definition at line 101 of file FileStatsCollector.cc.

References fc_, fo_, highestSubRun_, inputFilesSeen_, lowestSubRun_, nEvents_, and subRunsSeen_.

Referenced by recordFileOpen().

{
  fo_ = fc_ = boost::posix_time::ptime();
  lowestSubRun_ = highestSubRun_ = SubRunID{};
  inputFilesSeen_.clear();
  nEvents_ = 0ul;
  subRunsSeen_.clear();
}

std::set< art::SubRunID > const & art::FileStatsCollector::seenSubRuns ( ) const

inline

Definition at line 133 of file FileStatsCollector.h.

References subRunsSeen_.

Referenced by art::RootOutputFile::writeFileCatalogMetadata().

{
  return subRunsSeen_;
}

Member Data Documentation

boost::posix_time::ptime art::FileStatsCollector::fc_ {}

private

Definition at line 58 of file FileStatsCollector.h.

Referenced by outputFileCloseTime(), recordFileClose(), and resetStatistics_().

bool art::FileStatsCollector::fileCloseRecorded_ {false}

private

Definition at line 59 of file FileStatsCollector.h.

Referenced by fileCloseRecorded(), recordFileClose(), and recordFileOpen().

boost::posix_time::ptime art::FileStatsCollector::fo_ {}

private

Definition at line 57 of file FileStatsCollector.h.

Referenced by outputFileOpenTime(), recordFileOpen(), and resetStatistics_().

EventID art::FileStatsCollector::highestEventIDSeen_ {}

private

Definition at line 56 of file FileStatsCollector.h.

Referenced by highestEventID(), and recordEvent().

SubRunID art::FileStatsCollector::highestSubRun_ {}

private

Definition at line 54 of file FileStatsCollector.h.

Referenced by highestSubRunID(), recordRun(), recordSubRun(), and resetStatistics_().

std::vector<std::string> art::FileStatsCollector::inputFilesSeen_ {}

private

Definition at line 61 of file FileStatsCollector.h.

Referenced by parents(), recordFileOpen(), recordInputFile(), and resetStatistics_().

std::string art::FileStatsCollector::lastOpenedInputFile_ {}

private

Definition at line 60 of file FileStatsCollector.h.

Referenced by lastOpenedInputFile(), recordFileOpen(), and recordInputFile().

EventID art::FileStatsCollector::lowestEventIDSeen_ {}

private

Definition at line 55 of file FileStatsCollector.h.

Referenced by lowestEventID(), and recordEvent().

SubRunID art::FileStatsCollector::lowestSubRun_ {}

private

Definition at line 53 of file FileStatsCollector.h.

Referenced by lowestSubRunID(), recordRun(), recordSubRun(), and resetStatistics_().

std::string const art::FileStatsCollector::moduleLabel_

private

Definition at line 51 of file FileStatsCollector.h.

Referenced by moduleLabel().

std::size_t art::FileStatsCollector::nEvents_ {}

private

Definition at line 62 of file FileStatsCollector.h.

Referenced by eventsThisFile(), recordEvent(), and resetStatistics_().

std::string const art::FileStatsCollector::processName_

private

Definition at line 52 of file FileStatsCollector.h.

Referenced by FileStatsCollector(), and processName().

std::set<SubRunID> art::FileStatsCollector::subRunsSeen_ {}

private

Definition at line 63 of file FileStatsCollector.h.

Referenced by recordSubRun(), resetStatistics_(), and seenSubRuns().

---

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

• art/Framework/IO/FileStatsCollector.h
• art/Framework/IO/FileStatsCollector.cc