Public Types | Public Member Functions | Private Member Functions | List of all members
geo::ExptGeoHelperInterface Class Referenceabstract

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

#include <ExptGeoHelperInterface.h>

Inheritance diagram for geo::ExptGeoHelperInterface:
dune::DUNEGeometryHelper geo::StandardGeometryHelper

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 61 of file ExptGeoHelperInterface.h.

Member Typedef Documentation

Definition at line 64 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
sortingParametersparameters for the channel map algorithm
detectorNamename 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 79 of file ExptGeoHelperInterface.h.

81  {
82  return doConfigureChannelMapAlg(sortingParameters, detectorName);
83  }
virtual ChannelMapAlgPtr_t doConfigureChannelMapAlg(fhicl::ParameterSet const &sortingParameters, std::string const &detectorName) const =0
virtual ChannelMapAlgPtr_t geo::ExptGeoHelperInterface::doConfigureChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters,
std::string const &  detectorName 
) const
privatepure virtual

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