art::detail::InfoDumperInputFile Class Reference

#include "InfoDumperInputFile.h"

Public Types
using	EntryNumber = input::EntryNumber
using	EntryNumbers = input::EntryNumbers

Public Member Functions
	InfoDumperInputFile (std::string const &filename)
void	print_process_history (std::ostream &) const
void	print_range_sets (std::ostream &, bool compactRanges) const
void	print_event_list (std::ostream &) const
void	print_file_index (std::ostream &) const
void	print_branchIDLists (std::ostream &os) const
TFile *	tfile () const

Private Member Functions
RunAuxiliary	getAuxiliary (TTree *tree, EntryNumber const entry) const
RangeSet	getRangeSet (TTree *tree, EntryNumbers const &entries, sqlite3 *db, std::string const &filename, bool compactRanges) const

Private Attributes
std::unique_ptr< TFile >	file_
BranchIDLists	branchIDLists_ {}
ProcessHistoryMap	pHistMap_
FileIndex	fileIndex_
FileFormatVersion	fileFormatVersion_

Detailed Description

Definition at line 23 of file InfoDumperInputFile.h.

Member Typedef Documentation

using art::detail::InfoDumperInputFile::EntryNumber = input::EntryNumber

Definition at line 25 of file InfoDumperInputFile.h.

using art::detail::InfoDumperInputFile::EntryNumbers = input::EntryNumbers

Definition at line 26 of file InfoDumperInputFile.h.

Constructor & Destructor Documentation

art::detail::InfoDumperInputFile::InfoDumperInputFile

(

std::string const &

filename

)

Definition at line 61 of file InfoDumperInputFile.cc.

References branchIDLists_, file_, fileFormatVersion_, fileIndex_, art::rootNames::metaDataTreeName(), pHistMap_, art::detail::readFileIndex(), and art::detail::readMetadata().

  : file_{openFile(filename)}
{
  using namespace art::rootNames;
  std::unique_ptr<TTree> md{
    static_cast<TTree*>(file_->Get(metaDataTreeName().data()))};

  fileFormatVersion_ = detail::readMetadata<FileFormatVersion>(md.get());

  // Read BranchID lists if they exist
  detail::readMetadata(md.get(), branchIDLists_);

  // Read file index
  auto findexPtr = &fileIndex_;
  art::detail::readFileIndex(file_.get(), md.get(), findexPtr);

  // Read ProcessHistory
  pHistMap_ = detail::readMetadata<ProcessHistoryMap>(md.get());
}

Member Function Documentation

art::RunAuxiliary art::detail::InfoDumperInputFile::getAuxiliary ( TTree *  tree, EntryNumber const  entry  ) const

private

Definition at line 210 of file InfoDumperInputFile.cc.

References art::BranchTypeToAuxiliaryBranchName(), and art::InRun.

Referenced by getRangeSet(), and tfile().

{
  auto aux = std::make_unique<RunAuxiliary>();
  auto pAux = aux.get();
  TBranch* auxBranch =
    tree->GetBranch(BranchTypeToAuxiliaryBranchName(InRun).c_str());
  auxBranch->SetAddress(&pAux);
  tree->LoadTree(entry);
  auxBranch->GetEntry(entry);
  return *aux;
}

art::RangeSet art::detail::InfoDumperInputFile::getRangeSet ( TTree *  tree, EntryNumbers const &  entries, sqlite3 *  db, std::string const &  filename, bool  compactRanges  ) const

private

Definition at line 224 of file InfoDumperInputFile.cc.

References e, getAuxiliary(), art::InRun, art::detail::resolveRangeSet(), and art::detail::resolveRangeSetInfo().

Referenced by print_range_sets(), and tfile().

{
  auto resolve_info = [db, &filename](auto const id, bool const compact) {
    return detail::resolveRangeSetInfo(db, filename, InRun, id, compact);
  };

  auto auxResult = getAuxiliary(tree, entries[0]);
  auto rangeSetInfo = resolve_info(auxResult.rangeSetID(), compactRanges);

  for (auto i = entries.cbegin() + 1, e = entries.cend(); i != e; ++i) {
    auto const& tmpAux = getAuxiliary(tree, *i);
    rangeSetInfo.update(resolve_info(tmpAux.rangeSetID(), compactRanges),
                        compactRanges);
  }

  return resolveRangeSet(rangeSetInfo);
}

void art::detail::InfoDumperInputFile::print_branchIDLists

(

std::ostream &

os

)

const

Definition at line 130 of file InfoDumperInputFile.cc.

References branchIDLists_, fileFormatVersion_, art::errors::FileReadError, art::detail::orderedProcessNamesCollection(), pHistMap_, and art::FileFormatVersion::value_.

Referenced by print_branchIDLists().

{
  if (fileFormatVersion_.value_ >= 10) {
    std::ostringstream oss;
    oss << "  BranchIDLists are not stored for art/ROOT files with a format\n"
        << "  version of \"" << fileFormatVersion_ << "\".\n";
    throw Exception{errors::FileReadError,
                    "InfoDumperInputFile::print_branchIDLists:\n"}
      << oss.str();
  }

  auto const& processNames = orderedProcessNamesCollection(pHistMap_);
  // For older file format versions, there cannot be more than one
  // ordered process name, due to the compatibility requirements that
  // were enforced in generating the file.
  assert(processNames.size() == 1ull);

  os << "\n List of BranchIDs produced for this file.  The BranchIDs are\n"
     << " grouped according to the process in which they were produced.  The\n"
     << " processes are presented in chronological order; however within each "
        "process,\n"
     << " the order of listed BranchIDs is not meaningful.\n";
  unsigned i{};
  for (auto const& process : processNames.front()) {
    os << "\n Process " << i + 1 << ": " << process << '\n';
    for (auto const& bid : branchIDLists_[i]) {
      os << "    " << bid << '\n';
    }
    ++i;
  }
}

void art::detail::InfoDumperInputFile::print_event_list

(

std::ostream &

os

)

const

Definition at line 83 of file InfoDumperInputFile.cc.

References fileIndex_, and art::FileIndex::print_event_list().

Referenced by print_event_list().

{
  fileIndex_.print_event_list(os);
}

void art::detail::InfoDumperInputFile::print_file_index

(

std::ostream &

os

)

const

Definition at line 89 of file InfoDumperInputFile.cc.

References fileIndex_.

Referenced by print_file_index().

{
  os << fileIndex_;
}

void art::detail::InfoDumperInputFile::print_process_history

(

std::ostream &

os

)

const

Definition at line 95 of file InfoDumperInputFile.cc.

References art::detail::orderedProcessNamesCollection(), pHistMap_, and art::right().

Referenced by print_process_history().

{
  auto const& processNamesCollection = orderedProcessNamesCollection(pHistMap_);
  bool printHistoryLabel{false};
  if (processNamesCollection.empty()) {
    os << "\n No process history was recorded for this file.\n";
    return;
  } else if (processNamesCollection.size() > 1ull) {
    printHistoryLabel = true;
    os << "\n This file was produced with multiple processing histories.\n";
  }

  // Relying on a single character will be problematic if the
  // process-names collection has more than 26 elements.  Hopefully,
  // nobody will produce a job that involves the concatenation of more
  // than 26 inconsistent process histories.  If so, we'll solve the
  // process-history labeling below issue once we come to it.
  char hl{'A'};

  for (auto const& processNames : processNamesCollection) {
    unsigned i{1u};
    if (printHistoryLabel) {
      os << "\n Chronological list of process names for process history: "
         << hl++ << "\n\n";
    } else {
      os << "\n Chronological list of process names for processes that\n"
         << " produced this file.\n\n";
    }
    for (auto const& process : processNames) {
      os << ' ' << std::setw(4) << std::right << i++ << ". " << process << '\n';
    }
  }
}

void art::detail::InfoDumperInputFile::print_range_sets	(	std::ostream &	os,
		bool	compactRanges
	)		const

Definition at line 163 of file InfoDumperInputFile.cc.

References art::BranchTypeToProductTreeName(), art::FileIndex::cbegin(), art::FileIndex::cend(), file_, fileFormatVersion_, fileIndex_, getRangeSet(), art::InRun, art::FileIndex::kRun, art::detail::rangeSetFromFileIndex(), and art::FileFormatVersion::value_.

Referenced by print_range_sets().

{
  auto it = fileIndex_.cbegin();
  auto const cend = fileIndex_.cend();
  constexpr cet::HorizontalRule rule{30};
  std::string const rep{compactRanges ? "compact" : "full (default)"};

  if (fileFormatVersion_.value_ < 9) {
    os << '\n'
       << "*** This file has a format version of \"" << fileFormatVersion_
       << "\" and therefore\n"
       << "*** does not contain range-set information.  The printout below is\n"
       << "*** the range set art would assign to this file.\n\n"
       << "Representation: " << rep << '\n'
       << rule('-') << '\n';

    for (auto const& element : fileIndex_) {
      if (element.getEntryType() != art::FileIndex::kRun)
        continue;
      auto const& rs = rangeSetFromFileIndex(
        fileIndex_, element.eventID_.runID(), compactRanges);
      os << rs << '\n';
    }
    return;
  }

  auto* tree =
    static_cast<TTree*>(file_->Get(BranchTypeToProductTreeName(InRun).c_str()));
  SQLite3Wrapper db{file_.get(), "RootFileDB"};

  os << "Representation: " << rep << '\n' << rule('-') << '\n';
  while (it != cend) {
    if (it->getEntryType() != art::FileIndex::kRun) {
      ++it;
      continue;
    }
    // getEntryNumbers increments iterator!
    auto const& entries = getEntryNumbers(it, cend);
    auto const& rs =
      getRangeSet(tree, entries, db, file_->GetName(), compactRanges);
    os << rs << '\n';
  }
}

TFile* art::detail::InfoDumperInputFile::tfile ( ) const

inline

Definition at line 35 of file InfoDumperInputFile.h.

References file_, getAuxiliary(), and getRangeSet().

Referenced by db_to_file().

      {
        return file_.get();
      }

Member Data Documentation

BranchIDLists art::detail::InfoDumperInputFile::branchIDLists_ {}

private

Definition at line 50 of file InfoDumperInputFile.h.

Referenced by InfoDumperInputFile(), and print_branchIDLists().

std::unique_ptr<TFile> art::detail::InfoDumperInputFile::file_

private

Definition at line 49 of file InfoDumperInputFile.h.

Referenced by InfoDumperInputFile(), print_range_sets(), and tfile().

FileFormatVersion art::detail::InfoDumperInputFile::fileFormatVersion_

private

Definition at line 53 of file InfoDumperInputFile.h.

Referenced by InfoDumperInputFile(), print_branchIDLists(), and print_range_sets().

FileIndex art::detail::InfoDumperInputFile::fileIndex_

private

Definition at line 52 of file InfoDumperInputFile.h.

Referenced by InfoDumperInputFile(), print_event_list(), print_file_index(), and print_range_sets().

ProcessHistoryMap art::detail::InfoDumperInputFile::pHistMap_

private

Definition at line 51 of file InfoDumperInputFile.h.

Referenced by InfoDumperInputFile(), print_branchIDLists(), and print_process_history().

---

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

• art/Framework/IO/Root/detail/InfoDumperInputFile.h
• art/Framework/IO/Root/detail/InfoDumperInputFile.cc