All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Member Functions | List of all members
lariov::ChannelStatusService Class Referenceabstract

Service providing information about the quality of channels. More...

#include <ChannelStatusService.h>

Inheritance diagram for lariov::ChannelStatusService:
lariov::SimpleChannelStatusService lariov::SIOVChannelStatusService

Public Types

using provider_type = ChannelStatusProvider
 

Public Member Functions

virtual ~ChannelStatusService ()=default
 Destructor. More...
 
ChannelStatusProvider const * provider () const
 
ChannelStatusProvider const & GetProvider () const
 Returns a reference to the service provider. More...
 
ChannelStatusProvider const & GetFilter () const
 
ChannelStatusProvider const * GetProviderPtr () const
 Returns a pointer to the service provider. More...
 
ChannelStatusProvider const * GetFilterPtr () const
 

Private Member Functions

virtual ChannelStatusProvider
const * 
DoGetProviderPtr () const =0
 Returns a pointer to the service provider. More...
 
virtual ChannelStatusProvider
const & 
DoGetProvider () const =0
 Returns a reference to the service provider. More...
 

Detailed Description

Service providing information about the quality of channels.

This service provides only a simple interface. Experiments need to implement and configure their own service implementing this interface. The simplest implementation is provided in LArSoft: SimpleChannelStatusService.

Currently, the service provides interface for the following information:

The use of this service replaces the deprecated ChannelFilter class. An algorithm that used to use ChannelFilter class can be updated. From:

 filter::ChannelFilter* chanFilt = new filter::ChannelFilter();

to

 art::ServiceHandle<lariov::ChannelStatusService const> chanFilt;

(include files CalibrationDBI/Interface/ChannelStatusService.h instead of Filters/ChannelFilter.h) or

 lariov::ChannelStatusProvider const& chanFilt
   = art::ServiceHandle<lariov::ChannelStatusService const>()
     ->GetProvider();

(include files CalibrationDBI/Interface/ChannelStatusService.h and CalibrationDBI/Interface/ChannelStatusProvider.h instead of Filters/ChannelFilter.h). The latter object can in principle be passed to algorithms that are not art-aware.

Definition at line 66 of file ChannelStatusService.h.

Member Typedef Documentation

Definition at line 70 of file ChannelStatusService.h.

Constructor & Destructor Documentation

virtual lariov::ChannelStatusService::~ChannelStatusService ( )
virtualdefault

Destructor.

Member Function Documentation

virtual ChannelStatusProvider const& lariov::ChannelStatusService::DoGetProvider ( ) const
privatepure virtual

Returns a reference to the service provider.

Implemented in lariov::SimpleChannelStatusService, and lariov::SIOVChannelStatusService.

virtual ChannelStatusProvider const* lariov::ChannelStatusService::DoGetProviderPtr ( ) const
privatepure virtual

Returns a pointer to the service provider.

Implemented in lariov::SimpleChannelStatusService, and lariov::SIOVChannelStatusService.

ChannelStatusProvider const& lariov::ChannelStatusService::GetFilter ( ) const
inline

Definition at line 84 of file ChannelStatusService.h.

84 { return GetProvider(); }
ChannelStatusProvider const & GetProvider() const
Returns a reference to the service provider.
ChannelStatusProvider const* lariov::ChannelStatusService::GetFilterPtr ( ) const
inline

Definition at line 92 of file ChannelStatusService.h.

93  { return GetProviderPtr(); }
ChannelStatusProvider const * GetProviderPtr() const
Returns a pointer to the service provider.
ChannelStatusProvider const& lariov::ChannelStatusService::GetProvider ( ) const
inline

Returns a reference to the service provider.

Definition at line 81 of file ChannelStatusService.h.

82  { return DoGetProvider(); }
virtual ChannelStatusProvider const & DoGetProvider() const =0
Returns a reference to the service provider.
ChannelStatusProvider const* lariov::ChannelStatusService::GetProviderPtr ( ) const
inline

Returns a pointer to the service provider.

Definition at line 89 of file ChannelStatusService.h.

90  { return DoGetProviderPtr(); }
virtual ChannelStatusProvider const * DoGetProviderPtr() const =0
Returns a pointer to the service provider.
ChannelStatusProvider const* lariov::ChannelStatusService::provider ( ) const
inline

Definition at line 97 of file ChannelStatusService.h.

98  { return GetProviderPtr(); }
ChannelStatusProvider const * GetProviderPtr() const
Returns a pointer to the service provider.

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