icarus::PMTconfigurationExtractorBase Class Reference

#include <PMTconfigurationExtractor.h>

Inheritance diagram for icarus::PMTconfigurationExtractorBase:

Public Types
using	ConfigurationData_t = sbn::PMTconfiguration

Static Public Member Functions
Utility
static fhicl::ParameterSet	convertConfigurationDocuments (fhicl::ParameterSet const &container, std::string const &configListKey, std::initializer_list< std::regex const > components)
	Returns a parameter set with the content of configuration_documents key from container. More...
template<typename RBegin , typename REnd >
static bool	matchKey (std::string const &key, RBegin rbegin, REnd rend)

Interface
static bool	mayHaveConfiguration (fhicl::ParameterSet const &pset)
	Returns whether pset may contain the needed configuration. More...
ConfigurationData_t	extract (fhicl::ParameterSet const &config) const
	Extracts all supported PMT configuration from config. More...
ConfigurationData_t	finalize (ConfigurationData_t config) const
	Finalizes the content of config and returns it. More...

Detailed Description

Definition at line 63 of file PMTconfigurationExtractor.h.

Member Typedef Documentation

using icarus::PMTconfigurationExtractorBase::ConfigurationData_t = sbn::PMTconfiguration

Definition at line 67 of file PMTconfigurationExtractor.h.

Member Function Documentation

fhicl::ParameterSet icarus::PMTconfigurationExtractorBase::convertConfigurationDocuments ( fhicl::ParameterSet const &  container, std::string const &  configListKey, std::initializer_list< std::regex const >  components  )

static

Returns a parameter set with the content of configuration_documents key from container.

Parameters

container	parameter set including a table with key configListKey
configListKey	name of the key in container with the configuration
components	keys to be converted (as regular expressions)

Returns

a parameter set

The configuration_documents element of container is processed: for each of its keys which match at least one of the components regular expression patterns (std::regex_match()), the associated string value is parsed with FHiCL parser, and the result is set as a FHiCL table in the output parameter set. For example, if the components are { std::regex{".*pmt.*"}, std::regex{".*trigger.*"} }, the returned value is a parameter set that may have keys like icaruspmtee01, icaruspmtew02, icarustrigger etc., each one with a FHiCL table as `value.

Definition at line 23 of file PMTconfigurationExtractor.cxx.

  {
  
  fhicl::ParameterSet const sourceConfig
    = container.get<fhicl::ParameterSet>(configListKey);
  
  fhicl::ParameterSet configDocs;
  for (auto const& key: sourceConfig.get_names()) {
    if (!sourceConfig.is_key_to_atom(key)) continue;
    
    if (!matchKey(key, components.begin(), components.end())) continue;
    
    std::string const psetStr = sourceConfig.get<std::string>(key);
    
    fhicl::ParameterSet pset;
    try {
      pset = fhicl::ParameterSet::make(psetStr);
    }
    catch (cet::exception& e) {
      throw cet::exception{ "convertConfigurationDocuments", "", e }
        << "Error parsing the content of key '" << configListKey << "." << key
        << "'; content was:\n" << psetStr << "\n";
    }
    
    configDocs.put(key, pset);
    
  } // for all main keys
  
  return configDocs;
} // convertConfigurationDocuments()

ConfigurationData_t icarus::PMTconfigurationExtractorBase::extract

(

fhicl::ParameterSet const &

config

)

const

Extracts all supported PMT configuration from config.

Parameters

config

a FHiCL parameter set with component configuration

Returns

an object with the supported PMT configuration

All PMT-related configuration that is known to this code is extracted and returned.

This function is undefined here: it must be overridden.

ConfigurationData_t icarus::PMTconfigurationExtractorBase::finalize ( ConfigurationData_t  config ) const

inline

Finalizes the content of config and returns it.

Definition at line 92 of file PMTconfigurationExtractor.h.

    { return config; }

template<typename RBegin , typename REnd >

bool icarus::PMTconfigurationExtractorBase::matchKey ( std::string const &  key, RBegin  rbegin, REnd  rend  )

static

Returns whether key matches at least one of the regular expressions in the [ rbegin, rend [ range.

Definition at line 483 of file PMTconfigurationExtractor.h.

{
  for (auto iRegex = rbegin; iRegex != rend; ++iRegex)
    if (std::regex_match(key, *iRegex)) return true;
  return false;
} // icarus::PMTconfigurationExtractorBase::matchKey()

static bool icarus::PMTconfigurationExtractorBase::mayHaveConfiguration ( fhicl::ParameterSet const &  pset )

inlinestatic

Returns whether pset may contain the needed configuration.

Definition at line 74 of file PMTconfigurationExtractor.h.

    { return pset.has_key("configuration_documents"); }

---

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

• PMTconfigurationExtractor.h
• PMTconfigurationExtractor.cxx