Inheritance diagram for geo::GeometryInfoCheck:

Classes
struct	Config

struct	GeometryInfoCheckInfo

struct	GeometryInfoConfig

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

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

using	ModuleType = EDAnalyzer

Public Member Functions
	GeometryInfoCheck (Parameters const &config)

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

virtual void	analyze (art::Event const &) 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
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...

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

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

Implements art::EDAnalyzer.

Definition at line 84 of file GeometryInfoCheck_module.cc.

84 {}

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

overridevirtual

Reimplemented from art::EDAnalyzer.

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

Member Data Documentation

std::optional<GeometryInfoCheckInfo> geo::GeometryInfoCheck::fCheckInfo

private

Information on the check on the regular geometry information.

Definition at line 94 of file GeometryInfoCheck_module.cc.

std::optional<GeometryInfoCheckInfo> geo::GeometryInfoCheck::fLegacyCheckInfo

private

Information on the check on the legacy geometry information.

Definition at line 97 of file GeometryInfoCheck_module.cc.

art::InputTag const geo::GeometryInfoCheck::GeometryConfigurationWriterTag { "GeometryConfigurationWriter" }

staticprivate

The name of the tag for the geometry information.

Definition at line 111 of file GeometryInfoCheck_module.cc.

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

larcore/test/Geometry/VersionCheck/GeometryInfoCheck_module.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation