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 Member Functions
	HitDataProductChecker (Parameters const &config)

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

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...

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