Inheritance diagram for geo::GeometryInfoCheck:

Classes
struct	Config

struct	GeometryInfoCheckInfo

struct	GeometryInfoConfig

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

Public Member Functions
	GeometryInfoCheck (Parameters const &config)

virtual void	beginRun (art::Run const &run) override

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

Private Member Functions
void	CheckGeometryInfo (art::Run const &run, GeometryInfoCheckInfo const &config) const

void	CheckLegacyGeometryInfo (art::Run const &run, GeometryInfoCheckInfo const &config) const

Static Private Member Functions
static std::optional < GeometryInfoCheckInfo >	makeGeometryInfoCheckInfo (fhicl::OptionalTable< GeometryInfoConfig > const &config)
	Fills a `GeometryInfoCheckInfo` out of the specified configuration. More...

Private Attributes
std::optional < GeometryInfoCheckInfo >	fCheckInfo
	Information on the check on the regular geometry information. More...

std::optional < GeometryInfoCheckInfo >	fLegacyCheckInfo
	Information on the check on the legacy geometry information. More...

Static Private Attributes
static art::InputTag const	GeometryConfigurationWriterTag { "GeometryConfigurationWriter" }
	The name of the tag for the geometry information. More...

Detailed Description

Definition at line 44 of file GeometryInfoCheck_module.cc.

Member Typedef Documentation

using geo::GeometryInfoCheck::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 78 of file GeometryInfoCheck_module.cc.

Constructor & Destructor Documentation

geo::GeometryInfoCheck::GeometryInfoCheck ( Parameters const & config )

explicit

Definition at line 146 of file GeometryInfoCheck_module.cc.

   : art::EDAnalyzer(config)
   , fCheckInfo(makeGeometryInfoCheckInfo(config().GeometryInfo))
   , fLegacyCheckInfo(makeGeometryInfoCheckInfo(config().GeometryLegacyInfo))
 {
   
   if (fCheckInfo)
    consumes<sumdata::GeometryConfigurationInfo>(GeometryConfigurationWriterTag);
   if (fLegacyCheckInfo) consumesMany<sumdata::RunData>();
   
   
   // --- BEGIN -- Configuration dump -------------------------------------------
   {
     mf::LogDebug log { "GeometryInfoCheck" };
     log << "Configuration:"
       << "\n - geometry configuration check:";
     if (fCheckInfo) {
       if (fCheckInfo->detectorName.empty()) log << " (any name)";
       else log << " must match '" << fCheckInfo->detectorName << "'";
       log << " [" << (fCheckInfo->required? "mandatory": "optional") << "]";
     }
     else log << "not requested";
     
     log << "\n - legacy geometry configuration information check:";
     if (fLegacyCheckInfo) {
       if (fLegacyCheckInfo->detectorName.empty()) log << " (any name)";
       else log << " must match '" << fLegacyCheckInfo->detectorName << "'";
       log << " [" << (fLegacyCheckInfo->required? "mandatory": "optional") << "]";
     }
     else log << "not requested";
     
   }
   // --- END -- Configuration dump ---------------------------------------------
   
 } // geo::GeometryInfoCheck::GeometryInfoCheck()

Member Function Documentation

virtual void geo::GeometryInfoCheck::analyze ( art::Event const & )

inlineoverridevirtual

Definition at line 84 of file GeometryInfoCheck_module.cc.

84 {}

void geo::GeometryInfoCheck::beginRun ( art::Run const & run )

overridevirtual

Definition at line 184 of file GeometryInfoCheck_module.cc.

                                                      {
   
   if (fCheckInfo) CheckGeometryInfo(run, fCheckInfo.value());
   if (fLegacyCheckInfo) CheckLegacyGeometryInfo(run, fLegacyCheckInfo.value());
   
 } // geo::GeometryInfoCheck::beginRun()

void geo::GeometryInfoCheck::CheckGeometryInfo	(	art::Run const &	run,
		GeometryInfoCheckInfo const &	config
	)		const

private

Performs a geometry information check.

Exceptions

cet::exception on check failures

Definition at line 194 of file GeometryInfoCheck_module.cc.

 {
   
   mf::LogDebug log { "GeometryInfoCheck" };
   log << "Check on geometry information.";
   
   //
   // fetch geometry information
   //
   art::Handle<sumdata::GeometryConfigurationInfo> hInfo;
   if (!run.getByLabel(GeometryConfigurationWriterTag, hInfo)) {
     log << "\nNo information found.";
     if (!config.required) return; // well... all ok?
     
     log << "\nUnfortunately, that was required...";
     throw cet::exception("GeometryInfoCheck")
       << "Required geometry information not found as '"
       << GeometryConfigurationWriterTag.encode() << "'\n";
   } // if no info
   
   sumdata::GeometryConfigurationInfo const& info { *hInfo };
   log
     << "\nFound geometry information (version " << info.dataVersion << ")"
       << " from '" << hInfo.provenance()->inputTag().encode() << "'"
     << "\nGeometry name is '" << info.detectorName << "'."
     ;
   
   //
   // check: the name
   //
   if (!config.detectorName.empty()
     && !case_insensitive_equal(info.detectorName, config.detectorName)
   ) {
     throw cet::exception("GeometryInfoCheck")
       << "Geometry information reports an unexpected name '"
       << info.detectorName << "' ('" << config.detectorName << "' expected)\n"
       ;
   } // if
   
   //
   // all checks done
   //
   
 } // geo::GeometryInfoCheck::CheckGeometryInfo()

void geo::GeometryInfoCheck::CheckLegacyGeometryInfo	(	art::Run const &	run,
		GeometryInfoCheckInfo const &	config
	)		const

private

Performs a legacy geometry information check

Exceptions

cet::exception on check failures

Definition at line 242 of file GeometryInfoCheck_module.cc.

 {
   
   mf::LogDebug log { "GeometryInfoCheck" };
   log << "Check on legacy geometry information.";
   
   //
   // fetch geometry information
   //
   //std::vector<art::Handle<sumdata::RunData>> hInfoList;
   //run.getManyByType(hInfoList);
   auto hInfoList = run.getMany<sumdata::RunData>();
   if (hInfoList.empty()) {
     log << "\nNo information found.";
     if (!config.required) return; // well... all ok?
     
     log << "\nUnfortunately, that was required...";
     throw cet::exception("GeometryInfoCheck")
       << "No legacy geometry information found!\n";
   } // if no info
   
   log << "\nFound " << hInfoList.size() << " legacy geometry records:";
   art::Handle<sumdata::RunData> const* hInfo = nullptr;
   for (auto const& handle: hInfoList) {
     log << "\n - " << handle.provenance()->inputTag().encode();
     if (handle.failedToGet()) log << " (not present)";
     else if (!hInfo) {
       hInfo = &handle;
       log << " (this will be used for the check)";
     }
   } // for all handles
   
   sumdata::RunData const& info { *(hInfo->product()) };
   log
     << "\nFound legacy geometry information "
     << "\nGeometry name is '" << info.DetName() << "'."
     ;
   
   //
   // check: the name
   //
   if (!config.detectorName.empty()
     && !case_insensitive_equal(info.DetName(), config.detectorName)
   ) {
     throw cet::exception("GeometryInfoCheck")
       << "Geometry legacy information reports an unexpected name '"
       << info.DetName() << "' ('" << config.detectorName << "' expected)\n"
       ;
   } // if
   
   //
   // all checks done
   //
   
 } // geo::GeometryInfoCheck::CheckLegacyGeometryInfo()

auto geo::GeometryInfoCheck::makeGeometryInfoCheckInfo ( fhicl::OptionalTable< GeometryInfoConfig > const & config )

staticprivate

Fills a GeometryInfoCheckInfo out of the specified configuration.

Definition at line 301 of file GeometryInfoCheck_module.cc.

 {
   GeometryInfoConfig infoConfig;
   if (!config(infoConfig)) return {};
   
   GeometryInfoCheckInfo info;
   info.required = infoConfig.Required();
   infoConfig.Name(info.detectorName); // so far, not specifying it defaults to empty
   
   return { std::move(info) };
 } // geo::GeometryInfoCheck::makeGeometryInfoCheckInfo()