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

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

#include <AuxDetExptGeoHelperInterface.h>

Public Types

using AuxDetChannelMapAlgPtr_t = std::unique_ptr< AuxDetChannelMapAlg >
 

Public Member Functions

virtual ~AuxDetExptGeoHelperInterface ()=default
 Virtual destructor; does nothing. More...
 
AuxDetChannelMapAlgPtr_t ConfigureAuxDetChannelMapAlg (fhicl::ParameterSet const &sortingParameters) const
 Configure and initialize the channel map. More...
 

Private Member Functions

virtual AuxDetChannelMapAlgPtr_t doConfigureAuxDetChannelMapAlg (fhicl::ParameterSet const &sortingParameters) const =0
 Implementation of ConfigureChannelMapAlg (pure virtual) More...
 

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 functions 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 60 of file AuxDetExptGeoHelperInterface.h.

Member Typedef Documentation

Definition at line 63 of file AuxDetExptGeoHelperInterface.h.

Constructor & Destructor Documentation

virtual geo::AuxDetExptGeoHelperInterface::~AuxDetExptGeoHelperInterface ( )
virtualdefault

Virtual destructor; does nothing.

Member Function Documentation

AuxDetExptGeoHelperInterface::AuxDetChannelMapAlgPtr_t geo::AuxDetExptGeoHelperInterface::ConfigureAuxDetChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters) const
inline

Configure and initialize the channel map.

Parameters
sortingParametersparameters for the channel map algorithm
geompointer to a geometry description object
Returns
a (shared) pointer to the channel mapping algorithm

This method creates a new ChannelMapAlg according to the geometry and specified configuration, then it configures the geometry itself according to the channel map (usually, it resorts the data).

Definition at line 95 of file AuxDetExptGeoHelperInterface.h.

96  {
97  return doConfigureAuxDetChannelMapAlg(sortingParameters);
98  }
virtual AuxDetChannelMapAlgPtr_t doConfigureAuxDetChannelMapAlg(fhicl::ParameterSet const &sortingParameters) const =0
Implementation of ConfigureChannelMapAlg (pure virtual)
virtual AuxDetChannelMapAlgPtr_t geo::AuxDetExptGeoHelperInterface::doConfigureAuxDetChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters) const
privatepure virtual

Implementation of ConfigureChannelMapAlg (pure virtual)


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