o2::quality_control::checker::CheckInterface Class Reference

Skeleton of a check. More...

#include <CheckInterface.h>

Inheritance diagram for o2::quality_control::checker::CheckInterface:

Collaboration diagram for o2::quality_control::checker::CheckInterface:

Public Member Functions
	CheckInterface ()=default
	Default constructor.
virtual	~CheckInterface ()=default
	Destructor.
virtual void	configure (std::string name)=0
	Configure the check based on its name. More...
virtual Quality	check (std::map< std::string, std::shared_ptr< MonitorObject >> *moMap)=0
	Returns the quality associated with these objects. More...
virtual void	beautify (std::shared_ptr< MonitorObject > mo, Quality checkResult=Quality::Null)=0
	Modify the aspect of the plot. More...
virtual std::string	getAcceptedType ()
	Returns the name of the class that can be treated by this check. More...
bool	isObjectCheckable (const std::shared_ptr< MonitorObject > mo)
bool	isObjectCheckable (const MonitorObject *mo)
void	setCustomParameters (const std::unordered_map< std::string, std::string > &parameters)

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

Detailed Description

Skeleton of a check.

Author

Barthelemy von Haller

Member Function Documentation

virtual void o2::quality_control::checker::CheckInterface::beautify ( std::shared_ptr< MonitorObject >  mo, Quality  checkResult = Quality::Null  )

pure virtual

Modify the aspect of the plot.

Modify the aspect of the plot. It is usually based on the result of the check (passed as quality)

Parameters

mo	The MonitorObject to beautify.
checkResult	The quality returned by the check. It is not the same as the quality of the mo as the latter represents the combination of all the checks the mo passed. This parameter is to be used to pass the result of the check of the same class.

Implemented in TestCheck, o2::quality_control::test::TestCheck, o2::quality_control_modules::phos::RawCheck, o2::quality_control_modules::emcal::RawCheck, o2::quality_control_modules::mft::BasicClusterQcCheck, o2::quality_control_modules::mft::BasicDigitQcCheck, o2::quality_control_modules::mft::BasicTrackQcCheck, o2::quality_control_modules::muonchambers::PhysicsCheck, o2::quality_control_modules::tof::CheckCompressedData, o2::quality_control_modules::tof::CheckDiagnostics, o2::quality_control_modules::muonchambers::PedestalsCheck, o2::quality_control_modules::tof::CheckRawMultiplicity, o2::quality_control_modules::common::MeanIsAbove, o2::quality_control_modules::its::ITSFhrCheck, o2::quality_control_modules::tpc::PIDClusterCheck, o2::quality_control_modules::tpc::TrackClusterCheck, o2::quality_control_modules::emcal::DigitCheck, o2::quality_control_modules::ft0::DigitsCheck, o2::quality_control_modules::phos::DigitCheck, o2::quality_control_modules::tof::CheckRawTime, o2::quality_control_modules::tof::CheckRawToT, o2::quality_control_modules::common::EverIncreasingGraph, o2::quality_control_modules::common::NonEmpty, o2::quality_control_modules::mid::RawQcCheck, o2::quality_control_modules::skeleton::SkeletonCheck, o2::quality_control_modules::ft0::ChannelsCheck, o2::quality_control_modules::ft0::MergedTreeCheck, and o2::quality_control_modules::example::FakeCheck.

virtual Quality o2::quality_control::checker::CheckInterface::check ( std::map< std::string, std::shared_ptr< MonitorObject >> *  moMap )

pure virtual

Returns the quality associated with these objects.

Parameters

moMap

A map of the the MonitorObjects to check and their full names.

Returns

The quality associated with these objects.

Implemented in TestCheck, o2::quality_control::test::TestCheck, o2::quality_control_modules::phos::RawCheck, o2::quality_control_modules::emcal::RawCheck, o2::quality_control_modules::mft::BasicClusterQcCheck, o2::quality_control_modules::mft::BasicDigitQcCheck, o2::quality_control_modules::mft::BasicTrackQcCheck, o2::quality_control_modules::muonchambers::PhysicsCheck, o2::quality_control_modules::tof::CheckCompressedData, o2::quality_control_modules::tof::CheckDiagnostics, o2::quality_control_modules::muonchambers::PedestalsCheck, o2::quality_control_modules::tof::CheckRawMultiplicity, o2::quality_control_modules::common::MeanIsAbove, o2::quality_control_modules::its::ITSFhrCheck, o2::quality_control_modules::tpc::PIDClusterCheck, o2::quality_control_modules::tpc::TrackClusterCheck, o2::quality_control_modules::emcal::DigitCheck, o2::quality_control_modules::ft0::DigitsCheck, o2::quality_control_modules::phos::DigitCheck, o2::quality_control_modules::tof::CheckRawTime, o2::quality_control_modules::tof::CheckRawToT, o2::quality_control_modules::common::EverIncreasingGraph, o2::quality_control_modules::common::NonEmpty, o2::quality_control_modules::mid::RawQcCheck, o2::quality_control_modules::skeleton::SkeletonCheck, o2::quality_control_modules::ft0::ChannelsCheck, o2::quality_control_modules::ft0::MergedTreeCheck, and o2::quality_control_modules::example::FakeCheck.

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

pure virtual

Configure the check 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.

Implemented in TestCheck, o2::quality_control::test::TestCheck, o2::quality_control_modules::phos::RawCheck, o2::quality_control_modules::emcal::RawCheck, o2::quality_control_modules::mft::BasicClusterQcCheck, o2::quality_control_modules::mft::BasicDigitQcCheck, o2::quality_control_modules::mft::BasicTrackQcCheck, o2::quality_control_modules::muonchambers::PhysicsCheck, o2::quality_control_modules::tof::CheckCompressedData, o2::quality_control_modules::tof::CheckDiagnostics, o2::quality_control_modules::muonchambers::PedestalsCheck, o2::quality_control_modules::tof::CheckRawMultiplicity, o2::quality_control_modules::common::MeanIsAbove, o2::quality_control_modules::its::ITSFhrCheck, o2::quality_control_modules::tpc::PIDClusterCheck, o2::quality_control_modules::tpc::TrackClusterCheck, o2::quality_control_modules::emcal::DigitCheck, o2::quality_control_modules::ft0::DigitsCheck, o2::quality_control_modules::phos::DigitCheck, o2::quality_control_modules::tof::CheckRawTime, o2::quality_control_modules::tof::CheckRawToT, o2::quality_control_modules::common::EverIncreasingGraph, o2::quality_control_modules::common::NonEmpty, o2::quality_control_modules::mid::RawQcCheck, o2::quality_control_modules::skeleton::SkeletonCheck, o2::quality_control_modules::ft0::ChannelsCheck, o2::quality_control_modules::ft0::MergedTreeCheck, and o2::quality_control_modules::example::FakeCheck.

std::string o2::quality_control::checker::CheckInterface::getAcceptedType ( )

virtual

Returns the name of the class that can be treated by this check.

The name of the class returned by this method will be checked against the MonitorObject's encapsulated object's class. If it is the same or a parent then the check will be applied. Therefore, this method must return the highest class in the hierarchy that this check can use. If the class does not override it, we return "TObject".

Author

Barthelemy von Haller

Reimplemented in TestCheck, o2::quality_control::test::TestCheck, o2::quality_control_modules::phos::RawCheck, o2::quality_control_modules::emcal::RawCheck, o2::quality_control_modules::mft::BasicClusterQcCheck, o2::quality_control_modules::mft::BasicDigitQcCheck, o2::quality_control_modules::mft::BasicTrackQcCheck, o2::quality_control_modules::muonchambers::PhysicsCheck, o2::quality_control_modules::tof::CheckCompressedData, o2::quality_control_modules::tof::CheckDiagnostics, o2::quality_control_modules::muonchambers::PedestalsCheck, o2::quality_control_modules::tof::CheckRawMultiplicity, o2::quality_control_modules::common::MeanIsAbove, o2::quality_control_modules::its::ITSFhrCheck, o2::quality_control_modules::tpc::PIDClusterCheck, o2::quality_control_modules::tpc::TrackClusterCheck, o2::quality_control_modules::emcal::DigitCheck, o2::quality_control_modules::ft0::DigitsCheck, o2::quality_control_modules::phos::DigitCheck, o2::quality_control_modules::tof::CheckRawTime, o2::quality_control_modules::tof::CheckRawToT, o2::quality_control_modules::common::EverIncreasingGraph, o2::quality_control_modules::common::NonEmpty, o2::quality_control_modules::mid::RawQcCheck, o2::quality_control_modules::skeleton::SkeletonCheck, o2::quality_control_modules::ft0::ChannelsCheck, o2::quality_control_modules::ft0::MergedTreeCheck, and o2::quality_control_modules::example::FakeCheck.

---

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

• Framework/include/QualityControl/CheckInterface.h
• Framework/src/CheckInterface.cxx