LArSoft  v10_04_05
Liquid Argon Software toolkit - https://larsoft.org/
geo::WireReadoutSetupTool Class Referenceabstract

Interface for a tool creating a channel mapping object. More...

#include "WireReadoutSetupTool.h"

Public Member Functions

virtual ~WireReadoutSetupTool () noexcept=default
 
std::unique_ptr< geo::WireReadoutGeomsetupWireReadout (geo::GeometryCore const *geom, std::unique_ptr< WireReadoutSorter > sorter)
 Returns a new instance of the channel mapping. More...
 

Protected Member Functions

Virtual interface
virtual std::unique_ptr< geo::WireReadoutGeomdoWireReadout (geo::GeometryCore const *geom, std::unique_ptr< WireReadoutSorter > sorter)=0
 Returns a pointer to the channel mapping. More...
 

Detailed Description

Interface for a tool creating a channel mapping object.

This class creates a geo::WireReadoutGeom instance.

Definition at line 25 of file WireReadoutSetupTool.h.

Constructor & Destructor Documentation

virtual geo::WireReadoutSetupTool::~WireReadoutSetupTool ( )
virtualdefaultnoexcept

Member Function Documentation

virtual std::unique_ptr<geo::WireReadoutGeom> geo::WireReadoutSetupTool::doWireReadout ( geo::GeometryCore const *  geom,
std::unique_ptr< WireReadoutSorter sorter 
)
protectedpure virtual

Returns a pointer to the channel mapping.

Referenced by setupWireReadout().

std::unique_ptr<geo::WireReadoutGeom> geo::WireReadoutSetupTool::setupWireReadout ( geo::GeometryCore const *  geom,
std::unique_ptr< WireReadoutSorter sorter 
)
inline

Returns a new instance of the channel mapping.

If the call fails, a null pointer is returned. This may happen on calls following the first one, if the implementation does not support multiple calls. For all other errors, the implementations are expected to throw the proper exception.

Definition at line 38 of file WireReadoutSetupTool.h.

References doWireReadout().

41  {
42  return doWireReadout(geom, std::move(sorter));
43  }
virtual std::unique_ptr< geo::WireReadoutGeom > doWireReadout(geo::GeometryCore const *geom, std::unique_ptr< WireReadoutSorter > sorter)=0
Returns a pointer to the channel mapping.

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