geo::ExptGeoHelperInterface Class Reference

Interface to a service with detector-specific geometry knowledge. More...

#include <ExptGeoHelperInterface.h>

Inheritance diagram for geo::ExptGeoHelperInterface:

Public Types
using	ChannelMapAlgPtr_t = std::unique_ptr< ChannelMapAlg >

Public Member Functions
virtual	~ExptGeoHelperInterface ()=default
	Virtual destructor; does nothing. More...
ChannelMapAlgPtr_t	ConfigureChannelMapAlg (fhicl::ParameterSet const &sortingParameters, std::string const &detectorName) const
	Configure and initialize the channel map. More...

Private Member Functions
virtual ChannelMapAlgPtr_t	doConfigureChannelMapAlg (fhicl::ParameterSet const &sortingParameters, std::string const &detectorName) const =0

Detailed Description

Interface to a service with detector-specific geometry knowledge.

This is an interface to a service that virtualizes detector or experiment-specific knowledge that is required by the Geometry service. Experiments implement the private virtual function within a concrete service provider class to perform the specified actions as appropriate for the particular experiment.

It is expected that such requests will occur infrequently within a job. Calculations that occur frequently should be handled via interfaces that are passed back to the Geometry service.

Note

The public interface for this service cannot be overriden. The experiment-specific sub-classes should implement only the private methods without promoting their visibility.

Definition at line 54 of file ExptGeoHelperInterface.h.

Member Typedef Documentation

using geo::ExptGeoHelperInterface::ChannelMapAlgPtr_t = std::unique_ptr<ChannelMapAlg>

Definition at line 57 of file ExptGeoHelperInterface.h.

Constructor & Destructor Documentation

virtual geo::ExptGeoHelperInterface::~ExptGeoHelperInterface ( )

virtualdefault

Virtual destructor; does nothing.

Member Function Documentation

ChannelMapAlgPtr_t geo::ExptGeoHelperInterface::ConfigureChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters, std::string const &  detectorName  ) const

inline

Configure and initialize the channel map.

Parameters

sortingParameters	parameters for the channel map algorithm
detectorName	name of detector described by geometry

Returns

a (shared) pointer to the channel mapping algorithm

This method creates a new ChannelMapAlg according to the geometry and specified configuration.

Definition at line 72 of file ExptGeoHelperInterface.h.

    {
      return doConfigureChannelMapAlg(sortingParameters, detectorName);
    }

virtual ChannelMapAlgPtr_t geo::ExptGeoHelperInterface::doConfigureChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters, std::string const &  detectorName  ) const

privatepure virtual

Implemented in icarus::IcarusGeometryHelper, geo::StandardGeometryHelper, and sbnd::SBNDGeometryHelper.

---

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

• ExptGeoHelperInterface.h