#include <DetectorPropertiesServiceStandard.h>

Inheritance diagram for detinfo::DetectorPropertiesServiceStandard:

Classes
struct	ServiceConfiguration_t

Public Types
using	Parameters = art::ServiceTable< ServiceConfiguration_t >

Public Types inherited from detinfo::DetectorPropertiesService
using	provider_type = detinfo::DetectorProperties

Public Member Functions
	DetectorPropertiesServiceStandard (fhicl::ParameterSet const &pset, art::ActivityRegistry &reg)

Public Member Functions inherited from detinfo::DetectorPropertiesService
virtual	~DetectorPropertiesService ()=default

DetectorPropertiesData	DataForJob () const

DetectorPropertiesData	DataForJob (detinfo::DetectorClocksData const &clockData) const

DetectorPropertiesData	DataFor (art::Event const &e) const

DetectorPropertiesData	DataFor (art::Event const &e, detinfo::DetectorClocksData const &clockData) const

Private Member Functions
DetectorPropertiesData	getDataForJob (DetectorClocksData const &clockData) const override

DetectorPropertiesData	getDataFor (art::Event const &, DetectorClocksData const &clockData) const override

void	postOpenFile (const std::string &filename)

bool	isDetectorPropertiesServiceStandard (const fhicl::ParameterSet &ps) const

Private Attributes
DetectorPropertiesStandard	fProp

fhicl::ParameterSet	fPS
	Original parameter set. More...

bool	fInheritNumberTimeSamples
	Flag saying whether to inherit NumberTimeSamples. More...

Detailed Description

Configuration parameters

This service passes the whole configuration down to its service provider, but it also reacts to:

InheritNumberTimeSamples (boolean; default: false): if true, the configuration database in the ROOT input file is queried and if a configuration for this service is found, it's used instead of the one from the current FHiCL configuration

Definition at line 37 of file DetectorPropertiesServiceStandard.h.

Member Typedef Documentation

using detinfo::DetectorPropertiesServiceStandard::Parameters = art::ServiceTable<ServiceConfiguration_t>

Definition at line 57 of file DetectorPropertiesServiceStandard.h.

Constructor & Destructor Documentation

detinfo::DetectorPropertiesServiceStandard::DetectorPropertiesServiceStandard	(	fhicl::ParameterSet const &	pset,
		art::ActivityRegistry &	reg
	)

Definition at line 26 of file DetectorPropertiesServiceStandard_service.cc.

     : fProp{pset,
             lar::providerFrom<geo::Geometry>(),
             lar::providerFrom<detinfo::LArPropertiesService>(),
             std::set<std::string>({"InheritNumberTimeSamples"})}
     , fPS{pset}
     , fInheritNumberTimeSamples{pset.get<bool>("InheritNumberTimeSamples", false)}
   {
     reg.sPostOpenFile.watch(this, &DetectorPropertiesServiceStandard::postOpenFile);
   }

Member Function Documentation

DetectorPropertiesData detinfo::DetectorPropertiesServiceStandard::getDataFor	(	art::Event const &	,
		DetectorClocksData const &	clockData
	)		const

inlineoverrideprivatevirtual

Implements detinfo::DetectorPropertiesService.

Definition at line 69 of file DetectorPropertiesServiceStandard.h.

     {
       return fProp.DataFor(clockData);
     }

DetectorPropertiesData detinfo::DetectorPropertiesServiceStandard::getDataForJob ( DetectorClocksData const & clockData ) const

inlineoverrideprivatevirtual

Implements detinfo::DetectorPropertiesService.

Definition at line 63 of file DetectorPropertiesServiceStandard.h.

     {
       return fProp.DataFor(clockData);
     }

bool detinfo::DetectorPropertiesServiceStandard::isDetectorPropertiesServiceStandard ( const fhicl::ParameterSet & ps ) const

private

Definition at line 135 of file DetectorPropertiesServiceStandard_service.cc.

   {
     // This method uses heuristics to determine whether the parameter
     // set passed as argument is a DetectorPropertiesService configuration
     // parameter set.
 
     return (ps.get<std::string>("service_type", "") == "DetectorPropertiesService") &&
            (ps.get<std::string>("service_provider", "") == "DetectorPropertiesServiceStandard");
   }

void detinfo::DetectorPropertiesServiceStandard::postOpenFile ( const std::string & filename )

private

Definition at line 43 of file DetectorPropertiesServiceStandard_service.cc.

   {
     // Use this method to figure out whether to inherit configuration
     // parameters from previous jobs.
 
     // There is no way currently to correlate parameter sets saved in
     // sqlite RootFileDB with process history (from MetaData tree).
     // Therefore, we use the approach of scanning every historical
     // parameter set in RootFileDB, and finding all parameter sets
     // that appear to be DetectorPropertiesService configurations.  If all
     // historical parameter sets are in agreement about the value of
     // an inherited parameter, then we accept the historical value,
     // print a message, and override the configuration parameter.  In
     // cases where the historical configurations are not in agreement
     // about the value of an inherited parameter, we ignore any
     // historical parameter values that are the same as the current
     // configured value of the parameter (that is, we resolve the
     // conflict in favor of parameters values that are different than
     // the current configuration).  If two or more historical values
     // differ from the current configuration, throw an exception.
     // Note that it is possible to give precendence to the current
     // configuration by disabling inheritance for that configuration
     // parameter.
 
     // Don't do anything if no parameters are supposed to be inherited.
 
     if (!fInheritNumberTimeSamples) return;
 
     // The only way to access art service metadata from the input file
     // is to open it as a separate TFile object.  Do that now.
 
     if (filename.empty()) { return; }
 
     std::unique_ptr<TFile> file{TFile::Open(filename.c_str(), "READ")};
     if (!file) { return; }
 
     if (file->IsZombie() || !file->IsOpen()) { return; }
 
     // Open the sqlite datatabase.
 
     art::SQLite3Wrapper sqliteDB(file.get(), "RootFileDB");
 
     // Loop over all stored ParameterSets.
 
     unsigned int iNumberTimeSamples = 0; // Combined value of NumberTimeSamples.
     unsigned int nNumberTimeSamples = 0; // Number of NumberTimeSamples parameters seen.
 
     sqlite3_stmt* stmt = nullptr;
     sqlite3_prepare_v2(sqliteDB, "SELECT PSetBlob from ParameterSets;", -1, &stmt, nullptr);
     while (sqlite3_step(stmt) == SQLITE_ROW) {
       fhicl::ParameterSet ps;
       ps = fhicl::ParameterSet::make(reinterpret_cast<char const*>(sqlite3_column_text(stmt, 0)));
       // Is this a DetectorPropertiesService parameter set?
 
       if (isDetectorPropertiesServiceStandard(ps)) {
 
         // Check NumberTimeSamples
 
         auto const newNumberTimeSamples = ps.get<unsigned int>("NumberTimeSamples");
 
         // Ignore parameter values that match the current configuration.
 
         if (newNumberTimeSamples != fPS.get<unsigned int>("NumberTimeSamples")) {
           if (nNumberTimeSamples == 0)
             iNumberTimeSamples = newNumberTimeSamples;
           else if (newNumberTimeSamples != iNumberTimeSamples) {
             throw cet::exception(__FUNCTION__)
               << "Historical values of NumberTimeSamples do not agree: " << iNumberTimeSamples
               << " " << newNumberTimeSamples << "\n";
           }
           ++nNumberTimeSamples;
         }
       }
     }
 
     // Done looping over parameter sets.
     // Now decide which parameters we will actually override.
 
     if (nNumberTimeSamples != 0 && iNumberTimeSamples != fProp.NumberTimeSamples()) {
       mf::LogInfo("DetectorPropertiesServiceStandard")
         << "Overriding configuration parameter NumberTimeSamples using "
            "historical value.\n"
         << "  Configured value:        " << fProp.NumberTimeSamples() << "\n"
         << "  Historical (used) value: " << iNumberTimeSamples << "\n";
       fProp.SetNumberTimeSamples(iNumberTimeSamples);
     }
   }