art::RootDelayedReader Class Reference

#include "RootDelayedReader.h"

Inheritance diagram for art::RootDelayedReader:

Public Member Functions
	~RootDelayedReader ()=default
	RootDelayedReader (RootDelayedReader const &)=delete
RootDelayedReader &	operator= (RootDelayedReader const &)=delete
	RootDelayedReader (FileFormatVersion, sqlite3 *db, std::vector< input::EntryNumber > const &entrySet, input::BranchMap const &, cet::exempt_ptr< RootInputTree > tree, int64_t saveMemoryObjectThreshold, cet::exempt_ptr< RootInputFile > primaryFile, cet::exempt_ptr< BranchIDLists const > branchIDLists, BranchType branchType, EventID, bool compactSubRunRanges)
std::unique_ptr< EDProduct >	getProduct (BranchKey const &k, TypeID const &wrapper_type, RangeSet &rs) const
void	setGroupFinder (cet::exempt_ptr< EDProductGetterFinder const > ep)
int	openNextSecondaryFile (int idx)

Private Member Functions
std::unique_ptr< EDProduct >	getProduct_ (BranchKey const &, TypeID const &, RangeSet &) const override
void	setGroupFinder_ (cet::exempt_ptr< EDProductGetterFinder const >) override
int	openNextSecondaryFile_ (int idx) override

Private Attributes
FileFormatVersion	fileFormatVersion_
sqlite3 *	db_
std::vector< input::EntryNumber > const	entrySet_
input::BranchMap const &	branches_
cet::exempt_ptr< RootInputTree >	tree_
int64_t	saveMemoryObjectThreshold_
cet::exempt_ptr< EDProductGetterFinder const >	groupFinder_
cet::exempt_ptr< RootInputFile >	primaryFile_
cet::exempt_ptr< BranchIDLists const >	branchIDLists_
BranchType	branchType_
EventID	eventID_
bool const	compactSubRunRanges_

Detailed Description

Definition at line 29 of file RootDelayedReader.h.

Constructor & Destructor Documentation

art::RootDelayedReader::~RootDelayedReader ( )

default

art::RootDelayedReader::RootDelayedReader ( RootDelayedReader const &  )

delete

art::RootDelayedReader::RootDelayedReader	(	FileFormatVersion	version,
		sqlite3 *	db,
		std::vector< input::EntryNumber > const &	entrySet,
		input::BranchMap const &	branches,
		cet::exempt_ptr< RootInputTree >	tree,
		int64_t	saveMemoryObjectThreshold,
		cet::exempt_ptr< RootInputFile >	primaryFile,
		cet::exempt_ptr< BranchIDLists const >	branchIDLists,
		BranchType	branchType,
		EventID	eID,
		bool	compactSubRunRanges
	)

Definition at line 23 of file RootDelayedReader.cc.

References branches_, branchIDLists_, branchType_, compactSubRunRanges_, db_, entrySet_, eventID_, primaryFile_, saveMemoryObjectThreshold_, and tree_.

    : fileFormatVersion_{version}
    , db_{db}
    , entrySet_{entrySet}
    , branches_{branches}
    , tree_{tree}
    , saveMemoryObjectThreshold_{saveMemoryObjectThreshold}
    , primaryFile_{primaryFile}
    , branchIDLists_{bidLists}
    , branchType_{branchType}
    , eventID_{eID}
    , compactSubRunRanges_{compactSubRunRanges}
  {}

Member Function Documentation

std::unique_ptr<EDProduct> art::DelayedReader::getProduct ( BranchKey const &  k, TypeID const &  wrapper_type, RangeSet &  rs  ) const

inlineinherited

Definition at line 30 of file DelayedReader.h.

References art::DelayedReader::getProduct_().

    {
      return getProduct_(k, wrapper_type, rs);
    }

unique_ptr< EDProduct > art::RootDelayedReader::getProduct_ ( BranchKey const &  bk, TypeID const &  ty, RangeSet &  rs  ) const

overrideprivatevirtual

Implements art::DelayedReader.

Definition at line 56 of file RootDelayedReader.cc.

References branches_, branchIDLists_, branchType_, compactSubRunRanges_, db_, art::disjoint_ranges(), e, entrySet_, eventID_, fileFormatVersion_, art::RangeSet::forRun(), art::RangeSet::forSubRun(), art::input::getEntry(), groupFinder_, art::InRun, art::InSubRun, art::RangeSet::is_valid(), art::RangeSet::merge(), art::overlapping_ranges(), art::input::BranchInfo::productBranch_, art::errors::ProductCannotBeAggregated, art::detail::resolveRangeSet(), art::EventID::runID(), s, art::same_ranges(), saveMemoryObjectThreshold_, art::EventID::subRunID(), std::swap(), tree_, art::TypeID::typeInfo(), and art::FileFormatVersion::value_.

  {
    auto iter = branches_.find(bk);
    assert(iter != branches_.end());

    input::BranchInfo const& branchInfo = iter->second;
    TBranch* br{branchInfo.productBranch_};
    assert(br != nullptr);

    configureProductIDStreamer(branchIDLists_);
    configureRefCoreStreamer(groupFinder_);
    TClass* cl{TClass::GetClass(ty.typeInfo())};

    auto get_product = [this, cl, br](auto entry) {
      tree_->setEntryNumber(entry);
      unique_ptr<EDProduct> p{static_cast<EDProduct*>(cl->New())};
      EDProduct* pp{p.get()};
      br->SetAddress(&pp);
      auto const bytesRead = input::getEntry(br, entry);
      if ((saveMemoryObjectThreshold_ > -1) &&
          (bytesRead > saveMemoryObjectThreshold_)) {
        br->DropBaskets("all");
      }
      return p;
    };

    // Retrieve first product
    auto result = get_product(entrySet_[0]);

    // Retrieve and aggregate subsequent products (if they exist)
    if (branchType_ == InSubRun || branchType_ == InRun) {

      // Products from files that did not support RangeSets are
      // assigned RangeSets that correspond to the entire run/subrun.
      if (fileFormatVersion_.value_ < 9) {
        if (branchType_ == InRun) {
          rs = RangeSet::forRun(eventID_.runID());
        } else {
          rs = RangeSet::forSubRun(eventID_.subRunID());
        }
        configureProductIDStreamer();
        configureRefCoreStreamer();
        return result;
      }

      // Unfortunately, we cannot use detail::resolveRangeSetInfo in
      // this case because products that represent a full (Sub)Run are
      // allowed to be duplicated in an input file.  The behavior in
      // such a case is a NOP.
      RangeSet mergedRangeSet = detail::resolveRangeSet(db_,
                                                        "SomeInput"s,
                                                        branchType_,
                                                        result->getRangeSetID(),
                                                        compactSubRunRanges_);

      for (auto it = entrySet_.cbegin() + 1, e = entrySet_.cend(); it != e;
           ++it) {
        auto p = get_product(*it);
        auto const id = p->getRangeSetID();

        RangeSet const& newRS = detail::resolveRangeSet(
          db_, "SomeInput"s, branchType_, id, compactSubRunRanges_);
        if (!mergedRangeSet.is_valid() && newRS.is_valid()) {
          mergedRangeSet = newRS;
          std::swap(result, p);
        } else if (art::disjoint_ranges(mergedRangeSet, newRS)) {
          result->combine(p.get());
          mergedRangeSet.merge(newRS);
        } else if (art::same_ranges(mergedRangeSet, newRS)) {
          // The ranges are the same, so the behavior is a NOP.  If
          // the stakeholders decide that products with the same
          // ranges should be checked for equality, the condition
          // will be added here.
        } else if (art::overlapping_ranges(mergedRangeSet, newRS)) {
          throw Exception{errors::ProductCannotBeAggregated,
                          "RootDelayedReader::getProduct_"}
            << "\nThe following ranges corresponding to the product:\n"
            << "   '" << bk << "'"
            << "\ncannot be aggregated\n"
            << mergedRangeSet << " and\n"
            << newRS << "\nPlease contact [email protected].\n";
        }
        // NOP when both RangeSets are invalid
      }
      std::swap(rs, mergedRangeSet);
    }

    configureProductIDStreamer();
    configureRefCoreStreamer();
    return result;
  }

int art::DelayedReader::openNextSecondaryFile ( int  idx )

inlineinherited

Definition at line 44 of file DelayedReader.h.

References art::DelayedReader::getProduct_(), art::DelayedReader::openNextSecondaryFile_(), and art::DelayedReader::setGroupFinder_().

    {
      return openNextSecondaryFile_(idx);
    }

int art::RootDelayedReader::openNextSecondaryFile_ ( int  idx )

overrideprivatevirtual

Reimplemented from art::DelayedReader.

Definition at line 152 of file RootDelayedReader.cc.

References branchType_, eventID_, art::InEvent, art::InRun, art::InSubRun, primaryFile_, art::EventID::runID(), and art::EventID::subRunID().

  {
    // idx being a number we can actually use is a precondition of
    // this function.
    assert(!(idx < 0));

    // Note:
    //
    // Return code of -2 means stop, -1 means event-not-found,
    // otherwise 0 for success.
    //
    auto const& sfnm = primaryFile_->secondaryFileNames();
    assert(!(static_cast<decltype(sfnm.size())>(idx) > sfnm.size()));
    if (sfnm.empty()) { // No configured secondary files.
      return -2;
    }
    auto const& sf = primaryFile_->secondaryFiles();
    if (static_cast<decltype(sfnm.size())>(idx) == sfnm.size()) {
      // We're done.
      return -2;
    }

    if (!sf[idx]) {
      primaryFile_->openSecondaryFile(idx);
    }

    switch (branchType_) {
      case InEvent: {
        if (!sf[idx]->readEventForSecondaryFile(eventID_)) {
          return -1;
        }
      } break;
      case InSubRun: {
        if (!sf[idx]->readSubRunForSecondaryFile(eventID_.subRunID())) {
          return -1;
        }
      } break;
      case InRun: {
        if (!sf[idx]->readRunForSecondaryFile(eventID_.runID())) {
          return -1;
        }
      } break;
      default: {
        assert(false && "RootDelayedReader encountered an unknown BranchType!");
        return -2;
      }
    }
    return 0;
  }

RootDelayedReader& art::RootDelayedReader::operator= ( RootDelayedReader const &  )

delete

void art::DelayedReader::setGroupFinder ( cet::exempt_ptr< EDProductGetterFinder const >  ep )

inlineinherited

Definition at line 38 of file DelayedReader.h.

References art::DelayedReader::setGroupFinder_().

Referenced by art::EventPrincipal::EventPrincipal(), art::ResultsPrincipal::ResultsPrincipal(), art::RunPrincipal::RunPrincipal(), and art::SubRunPrincipal::SubRunPrincipal().

    {
      setGroupFinder_(ep);
    }

void art::RootDelayedReader::setGroupFinder_ ( cet::exempt_ptr< EDProductGetterFinder const >  groupFinder )

overrideprivatevirtual

Reimplemented from art::DelayedReader.

Definition at line 49 of file RootDelayedReader.cc.

References groupFinder_.

  {
    groupFinder_ = groupFinder;
  }

Member Data Documentation

input::BranchMap const& art::RootDelayedReader::branches_

private

Definition at line 60 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

cet::exempt_ptr<BranchIDLists const> art::RootDelayedReader::branchIDLists_

private

Definition at line 66 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

BranchType art::RootDelayedReader::branchType_

private

Definition at line 67 of file RootDelayedReader.h.

Referenced by getProduct_(), openNextSecondaryFile_(), and RootDelayedReader().

bool const art::RootDelayedReader::compactSubRunRanges_

private

Definition at line 69 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

sqlite3* art::RootDelayedReader::db_

private

Definition at line 58 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

std::vector<input::EntryNumber> const art::RootDelayedReader::entrySet_

private

Definition at line 59 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

EventID art::RootDelayedReader::eventID_

private

Definition at line 68 of file RootDelayedReader.h.

Referenced by getProduct_(), openNextSecondaryFile_(), and RootDelayedReader().

FileFormatVersion art::RootDelayedReader::fileFormatVersion_

private

Definition at line 57 of file RootDelayedReader.h.

Referenced by getProduct_().

cet::exempt_ptr<EDProductGetterFinder const> art::RootDelayedReader::groupFinder_

private

Definition at line 63 of file RootDelayedReader.h.

Referenced by getProduct_(), and setGroupFinder_().

cet::exempt_ptr<RootInputFile> art::RootDelayedReader::primaryFile_

private

Definition at line 64 of file RootDelayedReader.h.

Referenced by openNextSecondaryFile_(), and RootDelayedReader().

int64_t art::RootDelayedReader::saveMemoryObjectThreshold_

private

Definition at line 62 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

cet::exempt_ptr<RootInputTree> art::RootDelayedReader::tree_

private

Definition at line 61 of file RootDelayedReader.h.

Referenced by getProduct_(), and RootDelayedReader().

---

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

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