Module verifying the presence of data products. More...

Inheritance diagram for recob::test::HitDataProductChecker:

Classes
struct	Config

struct	TargetInfo_t
	Configuration for a single data product check. More...

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >

Public Types inherited from art::EDAnalyzer
using	WorkerType = WorkerT< EDAnalyzer >

using	ModuleType = EDAnalyzer

Public Member Functions
	HitDataProductChecker (Parameters const &config)

virtual void	analyze (const art::Event &event) override

Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDAnalyzer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept

	Analyzer (fhicl::ParameterSet const &pset)

template<typename Config >
	Analyzer (Table< Config > const &config)

void	doBeginJob (SharedResources const &resources)

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::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

fhicl::ParameterSetID	selectorConfig () const

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

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
template<typename DATA >
void	checkDataProducts (art::Event const &event, TargetInfo_t const &targetInfo, std::string desc)
	Checks the specified data product. More...

Private Attributes
std::vector< TargetInfo_t >	fHitTargets
	Configuration of all checks on hit collections. More...

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

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 ()

Detailed Description

Module verifying the presence of data products.

Throws an exception on failure.

Service requirements

This module requires no service.

Configuration parameters

hits (list, mandatory) each entry defines a check on a single hit collection data product (std::vector<recob::Hit>). Each entry is a table containing:
- name (string, mandatory): input tag of the data product
- exists (boolean, default: true): if true, the data product is expected to exist, if false it is expected not to exist
- expected (non-negative integral number): if specified, data collection size is checked to match this number

Definition at line 54 of file HitDataProductChecker_module.cc.

Member Typedef Documentation

using recob::test::HitDataProductChecker::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 91 of file HitDataProductChecker_module.cc.

Constructor & Destructor Documentation

recob::test::HitDataProductChecker::HitDataProductChecker ( Parameters const & config )

explicit

Definition at line 162 of file HitDataProductChecker_module.cc.

   : EDAnalyzer(config)
 {
   decltype(auto) hits = config().hits();
   fHitTargets.reserve(hits.size());
   std::copy(hits.begin(), hits.end(), std::back_inserter(fHitTargets));
 } // HitDataProductChecker::HitDataProductChecker()

Member Function Documentation

void recob::test::HitDataProductChecker::analyze ( const art::Event & event )

overridevirtual

Definition at line 172 of file HitDataProductChecker_module.cc.

                                                                   {
 
   for (auto const& targetInfo: fHitTargets)
     checkDataProducts<std::vector<recob::Hit>>(event, targetInfo, "hits");
 
 } // HitCollectionCreatorTest::analyze()

template<typename DATA >

void recob::test::HitDataProductChecker::checkDataProducts	(	art::Event const &	event,
		TargetInfo_t const &	targetInfo,
		std::string	desc
	)

private

Checks the specified data product.

Template Parameters

DATA	type of data product to be checked

Parameters

event	the event to read the data product from
targetInfo	details of the data product expected information
desc	description of the content of the data product

Exceptions

art::Exception (art::errors::ProductNotFound) when unexpected

The checks include:

existence of the data product
size of the data product collection (optional)

Definition at line 183 of file HitDataProductChecker_module.cc.

 {
   using Product_t = DATA;
 
   art::InputTag tag = targetInfo.name;
 
   art::Handle<Product_t> data;
   bool found = event.getByLabel<Product_t>(tag, data);
   if (found && !targetInfo.bExists) {
     throw art::Exception(art::errors::ProductNotFound)
       << "Data product '" << tag << "' (" << desc
       << ") was expected not to exist, and there it is instead! (with "
       << data->size() << " elements)";
   }
   if (!found && targetInfo.bExists) {
     throw art::Exception(art::errors::ProductNotFound)
       << "Data product '" << tag << "' (" << desc
       << ") was expected, but there is none.";
   }
 
   if (targetInfo.bCheckEntries && (data->size() != targetInfo.expectedEntries))
   {
     throw art::Exception(art::errors::ProductNotFound)
       << "Data product '" << tag << "' (" << desc
       << ") was expected to have " << targetInfo.expectedEntries
       << " entires, but it has " << data->size() << "!";
   }
 
 } // recob::test::HitDataProductChecker::HitCollectionCreator_test()

Member Data Documentation

std::vector<TargetInfo_t> recob::test::HitDataProductChecker::fHitTargets

private

Configuration of all checks on hit collections.

Definition at line 126 of file HitDataProductChecker_module.cc.

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

lardata/test/ArtDataHelper/HitDataProductChecker_module.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes