QualityControl  1.5.1
O2 Data Quality Control Framework
o2::quality_control::checker::AggregatorInterface Class Referenceabstract

Skeleton of a quality aggregator user algorithm. More...

#include <AggregatorInterface.h>

Inheritance diagram for o2::quality_control::checker::AggregatorInterface:
Collaboration diagram for o2::quality_control::checker::AggregatorInterface:

Public Member Functions

 AggregatorInterface ()=default
 Default constructor.
 
virtual ~AggregatorInterface ()=default
 Destructor.
 
virtual void configure (std::string name)=0
 Configure the aggregator based on its name. More...
 
virtual std::map< std::string, o2::quality_control::core::Qualityaggregate (std::map< std::string, std::shared_ptr< const o2::quality_control::core::QualityObject >> &qoMap)=0
 Returns new qualities (usually fewer) based on the input qualities. More...
 
void setCustomParameters (const std::unordered_map< std::string, std::string > &parameters)
 Set the custom parameters for this aggregator. Set the custom parameters for this aggregator. It is usually the ones defined in the configuration. More...
 

Protected Attributes

std::unordered_map< std::string, std::string > mCustomParameters
 

Detailed Description

Skeleton of a quality aggregator user algorithm.

Author
Barthelemy von Haller

Member Function Documentation

virtual std::map<std::string, o2::quality_control::core::Quality> o2::quality_control::checker::AggregatorInterface::aggregate ( std::map< std::string, std::shared_ptr< const o2::quality_control::core::QualityObject >> &  qoMap)
pure virtual

Returns new qualities (usually fewer) based on the input qualities.

Parameters
qoMapA map of the the QualityObjects to aggregate and their full names.
Returns
The new qualities, associated with a name.

Implemented in o2::quality_control::test::SimpleTestAggregator.

virtual void o2::quality_control::checker::AggregatorInterface::configure ( std::string  name)
pure virtual

Configure the aggregator based on its name.

The configuration of the object can't be done in the constructor because ROOT needs an argument-less constructor when streaming it. We use this method to configure the object. The name might be used to ask the configuration system for specific parameters.

Parameters
nameThe name of the aggregator.

Implemented in o2::quality_control::test::SimpleTestAggregator, and o2::quality_control_modules::skeleton::SkeletonAggregator.

void o2::quality_control::checker::AggregatorInterface::setCustomParameters ( const std::unordered_map< std::string, std::string > &  parameters)
inline

Set the custom parameters for this aggregator. Set the custom parameters for this aggregator. It is usually the ones defined in the configuration.

Parameters
parameters

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