LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
geo::ChannelMapSetupTool Class Referenceabstract

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

#include "ChannelMapSetupTool.h"

Public Member Functions

virtual ~ChannelMapSetupTool () noexcept=default
 
std::unique_ptr< geo::ChannelMapAlgsetupChannelMap ()
 Returns a new instance of the channel mapping. More...
 

Protected Member Functions

Virtual interface
virtual std::unique_ptr< geo::ChannelMapAlgdoChannelMap ()=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::ChannelMapAlg instance.

Definition at line 24 of file ChannelMapSetupTool.h.

Constructor & Destructor Documentation

virtual geo::ChannelMapSetupTool::~ChannelMapSetupTool ( )
virtualdefaultnoexcept

Member Function Documentation

virtual std::unique_ptr<geo::ChannelMapAlg> geo::ChannelMapSetupTool::doChannelMap ( )
protectedpure virtual

Returns a pointer to the channel mapping.

Referenced by setupChannelMap().

std::unique_ptr<geo::ChannelMapAlg> geo::ChannelMapSetupTool::setupChannelMap ( )
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 37 of file ChannelMapSetupTool.h.

References doChannelMap().

37 { return doChannelMap(); }
virtual std::unique_ptr< geo::ChannelMapAlg > doChannelMap()=0
Returns a pointer to the channel mapping.

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