testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard > Struct Template Reference

Set up a detinfo::DetectorPropertiesStandard from a parameter set. More...

#include <DetectorPropertiesStandardTestHelpers.h>

Static Public Member Functions
static std::unique_ptr< detinfo::DetectorPropertiesStandard >	setup (fhicl::ParameterSet const &pset, detinfo::DetectorPropertiesStandard::providers_type const &providers)
static std::unique_ptr< detinfo::DetectorPropertiesStandard >	setup (fhicl::ParameterSet const &pset, detinfo::DetectorPropertiesStandard::providers_type const &providers)

Detailed Description

template<>
struct testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard >

Set up a detinfo::DetectorPropertiesStandard from a parameter set.

Parameters

pset	parameter set for the configuration
providers	pack of providers needed by DetectorPropertiesService

Returns

pointer to a newly created and set up DetectorPropertiesService

This class specialisation enables the support of SetupProvider() methods of testing::TesterEnvironment. The resulting setup call will be something like:

env.SetupProviderFor
  <detinfo::DetectorPropertiesStandard, detinfo::DetectorProperties>
  (pset, env.ProviderPackFor<detinfo::DetectorPropertiesStandard>());

(note the use of SetupProviderFor() to register the service also as an implementation of DetectorProperties interface). This implicitly assumes that whatever service providers detinfo::DetectorPropertiesStandard needs, they have already been set up in the environment.

Definition at line 56 of file DetectorPropertiesStandardTestHelpers.h.

Member Function Documentation

static std::unique_ptr<detinfo::DetectorPropertiesStandard> testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard >::setup ( fhicl::ParameterSet const &  pset, detinfo::DetectorPropertiesStandard::providers_type const &  providers  )

inlinestatic

Todo:

remove this debug stuff!

Definition at line 59 of file DetectorPropertiesStandardTestHelpers.h.

      {
        // some feedback about whether we are using the right configuration
        std::string ServiceProviderPath;
        if (pset.get_if_present("service_provider", ServiceProviderPath)) {
          std::string ServiceProviderName = ServiceProviderPath;
          size_t iSlash = ServiceProviderPath.rfind('/');
          if (iSlash != std::string::npos)
            ServiceProviderName.erase(0, iSlash + 1);
          
          if (ServiceProviderName == "DetectorPropertiesServiceStandardGAr") {
            LOG_TRACE("ProviderSetup") << "Verified service implementation for "
              "DetectorPropertiesService"
              ": '" << ServiceProviderPath << "'";
          }
          else {
            // this means you should not be using the simple set up...
            mf::LogWarning("setupProvider")
              << "This set up is for a DetectorPropertiesStandard provider.\n"
              "Your configuration specifies a '" << ServiceProviderPath
              << "' service implementation"
              " that is not known to use that provider.";
          }
        }
    
        /// @todo remove this debug stuff!
        // 
        // create the new DetectorPropertiesStandard service provider
        //
        // we choose to ignore a configuration parameter that is known to be used
        // by the art services but unknown to the provider; in this way we can use
        // for this test the same configuration as for art-based tests.
        //
        std::set<std::string> ignore_keys({ "InheritNumberTimeSamples" });
        {
           mf::LogInfo debug("setupProvider<DetectorPropertiesStandard>");
           
           debug << "Asked to ignore " << ignore_keys.size() << " keys:";
           for (auto const& key: ignore_keys) debug << " '" << key << "'";
        }
        
        return std::make_unique<detinfo::DetectorPropertiesStandard>
          (pset, providers, ignore_keys);
      } // setup()

static std::unique_ptr<detinfo::DetectorPropertiesStandard> testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard >::setup ( fhicl::ParameterSet const &  pset, detinfo::DetectorPropertiesStandard::providers_type const &  providers  )

inlinestatic

Definition at line 58 of file DetectorPropertiesStandardTestHelpers.h.

    {
      // some feedback about whether we are using the right configuration
      std::string ServiceProviderPath;
      if (pset.get_if_present("service_provider", ServiceProviderPath)) {
        std::string ServiceProviderName = ServiceProviderPath;
        size_t iSlash = ServiceProviderPath.rfind('/');
        if (iSlash != std::string::npos) ServiceProviderName.erase(0, iSlash + 1);

        if (ServiceProviderName == "DetectorPropertiesServiceStandard") {
          MF_LOG_TRACE("ProviderSetup") << "Verified service implementation for "
                                           "DetectorPropertiesService"
                                           ": '"
                                        << ServiceProviderPath << "'";
        }
        else {
          // this means you should not be using the simple set up...
          mf::LogWarning("setupProvider")
            << "This set up is for a DetectorPropertiesStandard provider.\n"
               "Your configuration specifies a '"
            << ServiceProviderPath
            << "' service implementation"
               " that is not known to use that provider.";
        }
      }

      //
      // create the new DetectorPropertiesStandard service provider
      //
      // we choose to ignore a configuration parameter that is known to be used
      // by the art services but unknown to the provider; in this way we can use
      // for this test the same configuration as for art-based tests.
      //
      std::set<std::string> ignore_keys({"InheritNumberTimeSamples"});
      return std::make_unique<detinfo::DetectorPropertiesStandard>(
        pset,
        providers.get<geo::GeometryCore>(),
        providers.get<detinfo::LArProperties>(),
        ignore_keys);
    } // setup()

---

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

• garsoft/DetectorInfo/DetectorPropertiesStandardTestHelpers.h