art::test::ProductIDGetter Class Reference

Inheritance diagram for art::test::ProductIDGetter:

Classes
struct	Config

Public Types
using	Parameters = Table< Config >
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	ProductIDGetter (Parameters const &)
Public Member Functions inherited from art::EDProducer
	EDProducer ()=default
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer ()
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
void	doBeginJob ()
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
virtual	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	beginSubRun (art::SubRun &) override
void	produce (art::Event &) override

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Detailed Description

Definition at line 26 of file ProductIDGetter_module.cc.

Member Typedef Documentation

using art::test::ProductIDGetter::Parameters = Table<Config>

Definition at line 30 of file ProductIDGetter_module.cc.

Constructor & Destructor Documentation

art::test::ProductIDGetter::ProductIDGetter ( Parameters const &  ps )

explicit

Definition at line 38 of file ProductIDGetter_module.cc.

  : EDProducer{ps}
{
  produces<std::vector<int>, art::InSubRun>();
  produces<art::Ptr<int>, art::InSubRun>();
  produces<std::vector<int>>();
  produces<art::Ptr<int>>();
}

Member Function Documentation

void art::test::ProductIDGetter::beginSubRun ( art::SubRun &  sr )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 48 of file ProductIDGetter_module.cc.

{
  auto vip = std::make_unique<std::vector<int>>();
  vip->push_back(1);
  vip->push_back(3);
  vip->push_back(5);
  vip->push_back(7);

  art::ProductID const pv{sr.getProductID<std::vector<int>>()};
  auto ptr = std::make_unique<art::Ptr<int>>(pv, 2, sr.productGetter(pv));

  BOOST_REQUIRE(ptr->id().isValid());

  art::ProductID const id{sr.put(std::move(vip))};
  art::Ptr<int> const ptr_check{id, 2, sr.productGetter(id)};

  BOOST_REQUIRE_EQUAL(ptr->id(), ptr_check.id());
  BOOST_REQUIRE(!ptr_check.isAvailable());

  sr.put(std::move(ptr), art::fullSubRun());
}

void art::test::ProductIDGetter::produce ( art::Event &  e )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 71 of file ProductIDGetter_module.cc.

{
  // Test that getting a ProductID for an unregistered product yields an
  // exception.
  BOOST_REQUIRE_EXCEPTION(
    e.getProductID<int>(), art::Exception, [](art::Exception const& e) {
      return e.categoryCode() == art::errors::ProductRegistrationFailure;
    });

  auto vip = std::make_unique<std::vector<int>>();
  vip->push_back(0);
  vip->push_back(2);
  vip->push_back(4);
  vip->push_back(6);

  art::ProductID const pv{e.getProductID<std::vector<int>>()};
  auto ptr = std::make_unique<art::Ptr<int>>(pv, 2, e.productGetter(pv));

  BOOST_REQUIRE(ptr->id().isValid());

  art::ProductID const id{e.put(std::move(vip))};
  art::Ptr<int> const ptr_check{id, 2, e.productGetter(id)};

  BOOST_REQUIRE_EQUAL(ptr->id(), ptr_check.id());
  BOOST_REQUIRE(!ptr_check.isAvailable());

  e.put(std::move(ptr));
}

---

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

• art/art/test/Integration/ProductIDGetter_module.cc