TestCheck Class Reference

Inheritance diagram for TestCheck:

Collaboration diagram for TestCheck:

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

Public Attributes
bool	mCheck = false
bool	mBeautify = false

Additional Inherited Members
Protected Attributes inherited from o2::quality_control::checker::CheckInterface
std::unordered_map< std::string, std::string >	mCustomParameters

Member Function Documentation

void TestCheck::beautify ( std::shared_ptr< MonitorObject >  mo, Quality  checkResult = Quality::Null  )

inlinevirtual

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.

Implements o2::quality_control::checker::CheckInterface.

Quality TestCheck::check ( std::map< std::string, std::shared_ptr< MonitorObject >> *  moMap )

inlinevirtual

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.

Implements o2::quality_control::checker::CheckInterface.

void TestCheck::configure ( std::string  name )

inlinevirtual

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.

Implements o2::quality_control::checker::CheckInterface.

std::string TestCheck::getAcceptedType ( )

inlinevirtual

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 from o2::quality_control::checker::CheckInterface.

---

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

• Framework/test/testCheck.cxx