BareRootProductGetterBase Class Reference

#include <FWCore/FWLite/interface/BareRootProductGetterBase.h>

Inheritance diagram for BareRootProductGetterBase:

Classes
struct	Buffer

Public Member Functions
	BareRootProductGetterBase ()
	BareRootProductGetterBase (BareRootProductGetterBase const &)=delete
edm::WrapperBase const *	getIt (edm::ProductID const &) const override
edm::OptionalThinnedKey	getThinnedKeyFrom (edm::ProductID const &parent, unsigned int key, edm::ProductID const &thinned) const override
std::optional< std::tuple< edm::WrapperBase const *, unsigned int > >	getThinnedProduct (edm::ProductID const &, unsigned int key) const override
void	getThinnedProducts (edm::ProductID const &, std::vector< edm::WrapperBase const *> &foundContainers, std::vector< unsigned int > &keys) const override
BareRootProductGetterBase const &	operator= (BareRootProductGetterBase const &)=delete
	~BareRootProductGetterBase () override
Public Member Functions inherited from edm::EDProductGetter
	EDProductGetter ()
	EDProductGetter (EDProductGetter const &)=delete
EDProductGetter const &	operator= (EDProductGetter const &)=delete
unsigned int	transitionIndex () const
virtual	~EDProductGetter ()

Private Types
typedef std::map< edm::BranchID, Buffer >	IdToBuffers

Private Member Functions
Buffer *	createNewBuffer (edm::BranchID const &) const
virtual TFile *	currentFile () const =0
edm::WrapperBase const *	getIt (edm::BranchID const &, Long_t eventEntry) const
edm::ThinnedAssociation const *	getThinnedAssociation (edm::BranchID const &branchID, Long_t eventEntry) const
unsigned int	transitionIndex_ () const override

Private Attributes
fwlite::BranchMapReader	branchMap_
IdToBuffers	idToBuffers_

Additional Inherited Members
Static Public Member Functions inherited from edm::EDProductGetter
static void	assignEDProductGetter (EDProductGetter const *&)
static EDProductGetter const *	switchProductGetter (EDProductGetter const *)
	These can only be used internally by the framework. More...

Detailed Description

Description: <one line="" class="" summary>="">

This file was originally FWCore/FWLite/src/BareRootProductGetter.h, and was copied to the interface/BareRootProductGetterBase.h in order to refactor it a little bit to make it usable for FireworksWeb.

Usage: <usage>

Definition at line 47 of file BareRootProductGetterBase.h.

Member Typedef Documentation

IdToBuffers

typedef std::map<edm::BranchID, Buffer> BareRootProductGetterBase::IdToBuffers

private

Definition at line 119 of file BareRootProductGetterBase.h.

Constructor & Destructor Documentation

BareRootProductGetterBase() [1/2]

BareRootProductGetterBase::BareRootProductGetterBase ( )

default

~BareRootProductGetterBase()

BareRootProductGetterBase::~BareRootProductGetterBase ( )

overridedefault

BareRootProductGetterBase() [2/2]

BareRootProductGetterBase::BareRootProductGetterBase ( BareRootProductGetterBase const &  )

delete

Member Function Documentation

createNewBuffer()

BareRootProductGetterBase::Buffer * BareRootProductGetterBase::createNewBuffer ( edm::BranchID const &  branchID ) const

private

Definition at line 190 of file BareRootProductGetterBase.cc.

References b, MicroEventContent_cff::branch, fwlite::BranchMapReader::branchIDToBranch(), branchMap_, edm::BranchDescription::branchName(), edm::TypeWithDict::byName(), edm::BranchDescription::className(), runTheMatrix::const, Exception, newFWLiteAna::fullName, fwlite::BranchMapReader::getEventTree(), idToBuffers_, eostools::move(), dumpMFGeometry_cfg::prod, AlCaHLTBitMon_QueryRunRegistry::string, and edm::wrappedClassName().

Referenced by getIt().

                                                                                                             {
  //find the branch
  edm::BranchDescription const& bdesc = branchMap_.branchIDToBranch(branchID);

  TBranch* branch = branchMap_.getEventTree()->GetBranch(bdesc.branchName().c_str());
  if (nullptr == branch) {
    //we do not thrown on missing branches since 'getIt' should not throw under that condition
    return nullptr;
  }
  //find the class type
  std::string const fullName = edm::wrappedClassName(bdesc.className());
  edm::TypeWithDict classType(edm::TypeWithDict::byName(fullName));
  if (!bool(classType)) {
    throw cms::Exception("MissingDictionary") << "could not find dictionary for type '" << fullName << "'"
                                              << "\n Please make sure all the necessary libraries are available.";
    return nullptr;
  }

  TClass* rootClassType = TClass::GetClass(classType.typeInfo());
  if (nullptr == rootClassType) {
    throw cms::Exception("MissingRootDictionary") << "could not find a ROOT dictionary for type '" << fullName << "'"
                                                  << "\n Please make sure all the necessary libraries are available.";
    return nullptr;
  }
  void* address = rootClassType->New();

  static TClass const* edproductTClass = TClass::GetClass(typeid(edm::WrapperBase));
  edm::WrapperBase const* prod =
      static_cast<edm::WrapperBase const*>(rootClassType->DynamicCast(edproductTClass, address, true));
  if (nullptr == prod) {
    throw cms::Exception("FailedConversion") << "failed to convert a '" << fullName << "' to a edm::WrapperBase."
                                             << "Please contact developers since something is very wrong.";
  }

  //connect the instance to the branch
  //void* address  = wrapperObj.Address();
  Buffer b(prod, branch, address, rootClassType);
  idToBuffers_[branchID] = std::move(b);

  //As of 5.13 ROOT expects the memory address held by the pointer passed to
  // SetAddress to be valid forever
  address = &(idToBuffers_[branchID].address_);
  branch->SetAddress(address);

  return &(idToBuffers_[branchID]);
}

currentFile()

virtual TFile* BareRootProductGetterBase::currentFile ( ) const

privatepure virtual

Implemented in BareRootProductGetter.

Referenced by getIt().

getIt() [1/2]

edm::WrapperBase const * BareRootProductGetterBase::getIt ( edm::ProductID const &  pid ) const

overridevirtual

Implements edm::EDProductGetter.

Definition at line 46 of file BareRootProductGetterBase.cc.

References branchMap_, currentFile(), edm::poolNames::eventTreeName(), Exception, fwlite::BranchMapReader::getEventTree(), fwlite::BranchMapReader::getFile(), idToBuffers_, fwlite::BranchMapReader::productToBranchID(), fwlite::BranchMapReader::updateEvent(), and fwlite::BranchMapReader::updateFile().

Referenced by getThinnedAssociation(), getThinnedProduct(), and getThinnedProducts().

                                                                                    {
  // std::cout << "getIt called " << pid << std::endl;
  if (branchMap_.updateFile(currentFile())) {
    idToBuffers_.clear();
  }
  TTree* eventTree = branchMap_.getEventTree();
  // std::cout << "eventTree " << eventTree << std::endl;
  if (nullptr == eventTree) {
    throw cms::Exception("NoEventsTree")
        << "unable to find the TTree '" << edm::poolNames::eventTreeName() << "' in the last open file, \n"
        << "file: '" << branchMap_.getFile()->GetName()
        << "'\n Please check that the file is a standard CMS ROOT format.\n"
        << "If the above is not the file you expect then please open your data file after all other files.";
  }
  Long_t eventEntry = eventTree->GetReadEntry();
  // std::cout << "eventEntry " << eventEntry << std::endl;
  branchMap_.updateEvent(eventEntry);
  if (eventEntry < 0) {
    throw cms::Exception("GetEntryNotCalled")
        << "please call GetEntry for the 'Events' TTree for each event in order to make edm::Ref's work."
        << "\n Also be sure to call 'SetAddress' for all Branches after calling the GetEntry.";
  }

  edm::BranchID branchID = branchMap_.productToBranchID(pid);

  return getIt(branchID, eventEntry);
}

getIt() [2/2]

edm::WrapperBase const * BareRootProductGetterBase::getIt ( edm::BranchID const &  branchID, Long_t  eventEntry  ) const

private

Definition at line 74 of file BareRootProductGetterBase.cc.

References edmScanValgrind::buffer, runTheMatrix::const, createNewBuffer(), Exception, idToBuffers_, and dumpMFGeometry_cfg::prod.

                                                                                                           {
  Buffer* buffer = nullptr;
  IdToBuffers::iterator itBuffer = idToBuffers_.find(branchID);

  // std::cout << "Buffers" << std::endl;
  if (itBuffer == idToBuffers_.end()) {
    buffer = createNewBuffer(branchID);
    // std::cout << "buffer " << buffer << std::endl;
    if (nullptr == buffer) {
      return nullptr;
    }
  } else {
    buffer = &(itBuffer->second);
  }
  if (nullptr == buffer) {
    throw cms::Exception("NullBuffer") << "Found a null buffer which is supposed to hold the data item."
                                       << "\n Please contact developers since this message should not happen.";
  }
  if (nullptr == buffer->branch_) {
    throw cms::Exception("NullBranch") << "The TBranch which should hold the data item is null."
                                       << "\n Please contact the developers since this message should not happen.";
  }
  if (buffer->eventEntry_ != eventEntry) {
    //NOTE: Need to reset address because user could have set the address themselves
    //std::cout << "new event" << std::endl;

    //ROOT WORKAROUND: Create new objects so any internal data cache will get cleared
    void* address = buffer->class_->New();

    static TClass const* edproductTClass = TClass::GetClass(typeid(edm::WrapperBase));
    edm::WrapperBase const* prod =
        static_cast<edm::WrapperBase const*>(buffer->class_->DynamicCast(edproductTClass, address, true));

    if (nullptr == prod) {
      cms::Exception("FailedConversion") << "failed to convert a '" << buffer->class_->GetName()
                                         << "' to a edm::WrapperBase."
                                         << "Please contact developers since something is very wrong.";
    }
    buffer->address_ = address;
    buffer->product_ = std::shared_ptr<edm::WrapperBase const>(prod);
    //END WORKAROUND

    address = &(buffer->address_);
    buffer->branch_->SetAddress(address);

    buffer->branch_->GetEntry(eventEntry);
    buffer->eventEntry_ = eventEntry;
  }
  if (!buffer->product_) {
    throw cms::Exception("BranchGetEntryFailed")
        << "Calling GetEntry with index " << eventEntry << "for branch " << buffer->branch_->GetName() << " failed.";
  }

  return buffer->product_.get();
}

getThinnedAssociation()

edm::ThinnedAssociation const * BareRootProductGetterBase::getThinnedAssociation ( edm::BranchID const &  branchID, Long_t  eventEntry  ) const

private

Definition at line 237 of file BareRootProductGetterBase.cc.

References runTheMatrix::const, edm::WrapperBase::dynamicTypeInfo(), Exception, getIt(), edm::errors::LogicError, and wrapper.

Referenced by getThinnedKeyFrom(), getThinnedProduct(), and getThinnedProducts().

                                                                                                         {
  edm::WrapperBase const* wrapperBase = getIt(branchID, eventEntry);
  if (wrapperBase == nullptr) {
    throw edm::Exception(edm::errors::LogicError)
        << "BareRootProductGetterBase::getThinnedAssociation, product ThinnedAssociation not found.\n";
  }
  if (!(typeid(edm::ThinnedAssociation) == wrapperBase->dynamicTypeInfo())) {
    throw edm::Exception(edm::errors::LogicError)
        << "BareRootProductGetterBase::getThinnedAssociation, product has wrong type, not a ThinnedAssociation.\n";
  }
  edm::Wrapper<edm::ThinnedAssociation> const* wrapper =
      static_cast<edm::Wrapper<edm::ThinnedAssociation> const*>(wrapperBase);

  edm::ThinnedAssociation const* thinnedAssociation = wrapper->product();
  return thinnedAssociation;
}

getThinnedKeyFrom()

edm::OptionalThinnedKey BareRootProductGetterBase::getThinnedKeyFrom ( edm::ProductID const &  parent, unsigned int  key, edm::ProductID const &  thinned  ) const

overridevirtual

Implements edm::EDProductGetter.

Definition at line 156 of file BareRootProductGetterBase.cc.

References cms::Exception::addContext(), branchMap_, EcalMonitorTask_cff::func, fwlite::BranchMapReader::getEventTree(), getThinnedAssociation(), edm::detail::getThinnedKeyFrom_implementation(), edm::BranchID::isValid(), submitPVResolutionJobs::key, class-composition::parent, fwlite::BranchMapReader::productToBranchID(), runTheMatrix::ret, and fwlite::BranchMapReader::thinnedAssociationsHelper().

                                                                                                          {
  Long_t eventEntry = branchMap_.getEventTree()->GetReadEntry();
  edm::BranchID parent = branchMap_.productToBranchID(parentID);
  if (!parent.isValid())
    return std::monostate{};
  edm::BranchID thinned = branchMap_.productToBranchID(thinnedID);
  if (!thinned.isValid())
    return std::monostate{};
  try {
    auto ret = edm::detail::getThinnedKeyFrom_implementation(
        parentID,
        parent,
        key,
        thinnedID,
        thinned,
        branchMap_.thinnedAssociationsHelper(),
        [this, eventEntry](edm::BranchID const& branchID) { return getThinnedAssociation(branchID, eventEntry); });
    if (auto factory = std::get_if<edm::detail::GetThinnedKeyFromExceptionFactory>(&ret)) {
      return [func = *factory]() {
        auto ex = func();
        ex.addContext("Calling BareRootProductGetterBase::getThinnedKeyFrom()");
        return ex;
      };
    } else {
      return ret;
    }
  } catch (edm::Exception& ex) {
    ex.addContext("Calling BareRootProductGetterBase::getThinnedKeyFrom()");
    throw ex;
  }
}

getThinnedProduct()

std::optional< std::tuple< edm::WrapperBase const *, unsigned int > > BareRootProductGetterBase::getThinnedProduct ( edm::ProductID const &  pid, unsigned int  key  ) const

overridevirtual

Implements edm::EDProductGetter.

Definition at line 130 of file BareRootProductGetterBase.cc.

References b, branchMap_, fwlite::BranchMapReader::getEventTree(), getIt(), getThinnedAssociation(), edm::detail::getThinnedProduct(), submitPVResolutionJobs::key, AlCaHLTBitMon_ParallelJobs::p, fwlite::BranchMapReader::productToBranchID(), and fwlite::BranchMapReader::thinnedAssociationsHelper().

                                                     {
  Long_t eventEntry = branchMap_.getEventTree()->GetReadEntry();
  return edm::detail::getThinnedProduct(
      pid,
      key,
      branchMap_.thinnedAssociationsHelper(),
      [this](edm::ProductID const& p) { return branchMap_.productToBranchID(p); },
      [this, eventEntry](edm::BranchID const& b) { return getThinnedAssociation(b, eventEntry); },
      [this](edm::ProductID const& p) { return getIt(p); });
}

getThinnedProducts()

void BareRootProductGetterBase::getThinnedProducts ( edm::ProductID const &  pid, std::vector< edm::WrapperBase const *> &  foundContainers, std::vector< unsigned int > &  keys  ) const

overridevirtual

Implements edm::EDProductGetter.

Definition at line 142 of file BareRootProductGetterBase.cc.

References b, branchMap_, fwlite::BranchMapReader::getEventTree(), getIt(), getThinnedAssociation(), edm::detail::getThinnedProducts(), relativeConstraints::keys, AlCaHLTBitMon_ParallelJobs::p, fwlite::BranchMapReader::productToBranchID(), and fwlite::BranchMapReader::thinnedAssociationsHelper().

                                                                                        {
  Long_t eventEntry = branchMap_.getEventTree()->GetReadEntry();
  edm::detail::getThinnedProducts(
      pid,
      branchMap_.thinnedAssociationsHelper(),
      [this](edm::ProductID const& p) { return branchMap_.productToBranchID(p); },
      [this, eventEntry](edm::BranchID const& b) { return getThinnedAssociation(b, eventEntry); },
      [this](edm::ProductID const& p) { return getIt(p); },
      foundContainers,
      keys);
}

operator=()

BareRootProductGetterBase const& BareRootProductGetterBase::operator= ( BareRootProductGetterBase const &  )

delete

transitionIndex_()

unsigned int BareRootProductGetterBase::transitionIndex_ ( ) const

inlineoverrideprivatevirtual

Implements edm::EDProductGetter.

Definition at line 96 of file BareRootProductGetterBase.h.

{ return 0u; }

Member Data Documentation

branchMap_

fwlite::BranchMapReader BareRootProductGetterBase::branchMap_

mutableprivate

Definition at line 121 of file BareRootProductGetterBase.h.

Referenced by createNewBuffer(), getIt(), getThinnedKeyFrom(), getThinnedProduct(), and getThinnedProducts().

idToBuffers_

IdToBuffers BareRootProductGetterBase::idToBuffers_

mutableprivate

Definition at line 120 of file BareRootProductGetterBase.h.

Referenced by createNewBuffer(), and getIt().