art::ProducerBase Class Reference

#include "ProducerBase.h"

Inheritance diagram for art::ProducerBase:

Public Types
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
bool	modifiesEvent () const
template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

Private Member Functions
void	productList (ProductList *p)
void	registerProducts (MasterProductRegistry &mpr, ProductDescriptions &productsToRegister, ModuleDescription const &md)
template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)
template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})
template<typename P , art::BranchType B>
art::TypeLabel const &	reconstitutes (std::string const &emulatedModule, std::string const &instanceName)
template<BranchType B>
std::set< TypeLabel > const &	expectedProducts () const

Detailed Description

Definition at line 33 of file ProducerBase.h.

Member Typedef Documentation

template<typename UserConfig , typename UserKeysToIgnore = void>

using art::ProducerBase::Table = ProducerTable<UserConfig, detail::ModuleConfig, UserKeysToIgnore>

Definition at line 51 of file ProducerBase.h.

Member Function Documentation

template<BranchType B>

std::set<TypeLabel> const& art::ProductRegistryHelper::expectedProducts ( ) const

inlineinherited

Definition at line 111 of file ProductRegistryHelper.h.

References B, and art::ProductRegistryHelper::typeLabelList_.

  {
    return typeLabelList_[B];
  }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by modifiesEvent().

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

bool art::ProducerBase::modifiesEvent ( ) const

inline

Definition at line 40 of file ProducerBase.h.

References getProductID().

    {
      return true;
    }

template<typename P , art::BranchType B>

void art::ProductRegistryHelper::produces ( std::string const &  instanceName = {}, Persistable const  persistable = Persistable::Yes  )

inlineinherited

Definition at line 141 of file ProductRegistryHelper.h.

References B, art::ProductRegistryHelper::insertOrThrow(), art::No, art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

Referenced by larg4::LArG4::LArG4(), art::MixHelper::produces(), recob::ChargedSpacePointCollectionCreator::produces(), and art::ProductRegistryHelper::productList().

{
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  bool const isTransient = (persistable == Persistable::No);
  insertOrThrow(
    B,
    TypeLabel{productType, instanceName, SupportsView<P>::value, isTransient});
}

void art::ProductRegistryHelper::productList ( ProductList *  p )

inlineinherited

Definition at line 86 of file ProductRegistryHelper.h.

References art::ProductRegistryHelper::produces(), art::ProductRegistryHelper::productList_, art::ProductRegistryHelper::reconstitutes(), art::ProductRegistryHelper::registerProducts(), and art::Yes.

  {
    productList_.reset(p);
  }

template<typename P , BranchType B>

TypeLabel const& art::ProductRegistryHelper::reconstitutes ( std::string const &  modLabel, std::string const &  instanceName = {}  )

inherited

Referenced by lris::LArRawInputDriver::LArRawInputDriver(), lris::LArRawInputDriverJP250L::LArRawInputDriverJP250L(), lris::LArRawInputDriverLongBo::LArRawInputDriverLongBo(), lris::LArRawInputDriverShortBo::LArRawInputDriverShortBo(), and art::ProductRegistryHelper::productList().

template<typename P , art::BranchType B>

art::TypeLabel const& art::ProductRegistryHelper::reconstitutes ( std::string const &  emulatedModule, std::string const &  instanceName  )

inherited

Definition at line 155 of file ProductRegistryHelper.h.

References B, art::ProductRegistryHelper::insertOrThrow(), art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

{
  verifyModuleLabel(emulatedModule);
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  return insertOrThrow(
    B,
    TypeLabel{
      productType, instanceName, SupportsView<P>::value, emulatedModule});
}

void art::ProductRegistryHelper::registerProducts ( MasterProductRegistry &  mpr, ProductDescriptions &  productsToRegister, ModuleDescription const &  md  )

inherited

Definition at line 59 of file ProductRegistryHelper.cc.

References art::MasterProductRegistry::addProductsFromModule(), art::InEvent, art::NumBranchTypes, art::ProductRegistryHelper::productList_, art::ProductRegistryHelper::typeLabelList_, and art::MasterProductRegistry::updateFromModule().

Referenced by art::Source< T >::finishProductRegistration_(), art::ProductRegistryHelper::productList(), and art::ResultsProducer::registerProducts().

{
  // First update the MPR with any extant products.
  if (productList_) {
    cet::transform_all(*productList_,
                       back_inserter(productsToRegister),
                       [](auto const& pr) { return pr.second; });
    mpr.updateFromModule(move(productList_));
  }

  // Now go through products that will be produced in the current process.
  check_for_duplicate_Assns(typeLabelList_[InEvent]);

  ProductDescriptions descriptions;
  for (std::size_t ibt{}; ibt != NumBranchTypes; ++ibt) {
    auto const bt = static_cast<BranchType>(ibt);
    for (auto const& val : typeLabelList_[bt]) {
      BranchDescription pd{bt, val, md};
      productsToRegister.push_back(pd);
      descriptions.push_back(std::move(pd));
    }
  }
  mpr.addProductsFromModule(move(descriptions));
}

---

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

• art/Framework/Core/ProducerBase.h