art::ProducesCollector Class Reference

#include "ProducesCollector.h"

Public Member Functions
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={})
TypeLabelLookup_t const &	expectedProducts (BranchType) const
void	fillDescriptions (ModuleDescription const &md)

Private Member Functions
TypeLabel const &	insertOrThrow (BranchType const bt, TypeLabel const &tl)

Private Attributes
std::array< TypeLabelLookup_t, NumBranchTypes >	typeLabelList_ {{}}

Detailed Description

Definition at line 55 of file ProducesCollector.h.

Member Function Documentation

TypeLabelLookup_t const & art::ProducesCollector::expectedProducts ( BranchType  bt ) const

inline

Definition at line 81 of file ProducesCollector.h.

Referenced by art::ProductRegistryHelper::registerProducts().

  {
    return typeLabelList_[bt];
  }

void art::ProducesCollector::fillDescriptions

(

ModuleDescription const &

md

)

Definition at line 88 of file ProducesCollector.cc.

References art::for_each_branch_type(), art::ModuleDescription::moduleLabel(), art::ModuleDescription::parameterSetID(), and art::ModuleDescription::processConfiguration().

Referenced by art::ProductRegistryHelper::fillDescriptions().

  {
    auto fillDescriptionsPerBT = [this, &md](BranchType const bt) {
      auto& expectedProducts = typeLabelList_[bt];
      // Go through products that will be produced in the current process.
      check_for_duplicate_friendly_names(expectedProducts);

      for (auto& [typeLabel, pd] : expectedProducts) {
        pd = BranchDescription{bt,
                               typeLabel,
                               md.moduleLabel(),
                               md.parameterSetID(),
                               md.processConfiguration()};
      }
    };
    for_each_branch_type(fillDescriptionsPerBT);
  }

TypeLabel const & art::ProducesCollector::insertOrThrow ( BranchType const  bt, TypeLabel const &  tl  )

private

Definition at line 69 of file ProducesCollector.cc.

References art::TypeLabel::className(), art::TypeLabel::productInstanceName(), and art::errors::ProductRegistrationFailure.

  {
    auto result = typeLabelList_[bt].emplace(tl, BranchDescription{});
    if (!result.second) {
      ostringstream oss;
      oss << "An attempt was made to declare the following product in the same "
             "module:\n"
          << "Branch type: " << bt << '\n'
          << "Class name: " << tl.className() << '\n'
          << "Product instance name: " << tl.productInstanceName() << '\n';
      throw Exception{
        errors::ProductRegistrationFailure,
        "An error occurred during a call to 'produces' or 'reconstitutes'."}
        << oss.str();
    }
    return result.first->first;
  }

template<typename P , art::BranchType B>

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

inline

Definition at line 88 of file ProducesCollector.h.

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

Referenced by recob::HitAndAssociationsWriterBase::declare_products(), larg4::LArG4DetectorService::doCallArtProduces(), nnet::EmTrack< N >::EmTrack(), ShowerRecoTools::IShowerTool::InitialiseProduct(), artg4tk::DummyService::notifyArtOfProduction(), lar_cluster3d::SpacePointHit3DBuilder::produces(), lar_cluster3d::StandardHit3DBuilder::produces(), lar_cluster3d::SnippetHit3DBuilder::produces(), art::MixHelper::produces(), recob::ChargedSpacePointCollectionCreator::produces(), and anab::FVectorWriter< N >::produces_using().

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

template<typename P , BranchType B>

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

Definition at line 102 of file ProducesCollector.h.

References art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

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

Member Data Documentation

std::array<TypeLabelLookup_t, NumBranchTypes> art::ProducesCollector::typeLabelList_ {{}}

private

Definition at line 77 of file ProducesCollector.h.

---

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

• art/Framework/Core/ProducesCollector.h
• art/Framework/Core/ProducesCollector.cc