Base abstract class for object handler. More...

#include <CbmQaCheckerObjectHandler.h>

Inheritance diagram for cbm::qa::checker::ObjectHandler:

Public Member Functions
	ObjectHandler (int iObject, int iFile, int iDataset, const char *objType="")
	Default constructor.

virtual	~ObjectHandler ()
	Destructor.

void	AddObjects (const std::vector< TNamed * > &vpObj)
	Adds vector of pointer to objects.

virtual void	CreateCanvases (Option_t *)
	Creates object comparison canvas.

virtual Result	Compare (int iVersion) const =0
	Compares objects to default.

std::vector< Result >	CompareWithDefault ()
	Compares different versions with default.

void	SetOutputDirectory (TDirectory *pDir)
	Sets folder to store output.

void	SetObjectDB (std::shared_ptr< ObjectDB > &pObjDB)
	Sets objects database.

void	SetComparisonMethod (ECmpMethod method)
	Sets bit flag to control handler behaviour.

void	Write ()
	Writes objects to file.

Protected Attributes
std::string	fsObjType {""}
	Base type of the object to be handled.

std::string	fsBaseName {""}
	Base names of the object.

std::vector< TNamed * >	fvpObjects
	Vector of objects.

std::shared_ptr< ObjectDB >	fpObjDB {nullptr}
	Pointer to object database.

std::shared_ptr< TCanvas >	fpCanvasCmp {nullptr}
	Comparison canvas: plots together.

std::shared_ptr< TCanvas >	fpCanvasRat {nullptr}
	Comparison canvas: ratios to default.

std::shared_ptr< TCanvas >	fpCanvasDiff {nullptr}
	Comparison canvas: difference with default.

TDirectory *	fpOutDir {nullptr}
	Pointer to directory.

int	fObjectID {-1}
	Index of object.

int	fFileID {-1}
	Index of file.

int	fDatasetID {-1}
	Index of dataset.

std::bitset< static_cast< size_t >(ECmpMethod::END)>	fCmpBits
	Bitset for comparison methods.

Detailed Description

Base abstract class for object handler.

The class provides interface for handling objects of the same type, obtained under different versions of the code base.

Definition at line 32 of file CbmQaCheckerObjectHandler.h.

Constructor & Destructor Documentation

◆ ObjectHandler()

ObjectHandler::ObjectHandler	(	int	iObject,
		int	iFile,
		int	iDataset,
		const char *	objType = "" )

Default constructor.

Parameters

iObject	Index of object
iFile	Index of file
iDataset	Index of dataset
objType	Type of the handled objects

Definition at line 24 of file CbmQaCheckerObjectHandler.cxx.

References fDatasetID, fFileID, fObjectID, and fsObjType.

Referenced by cbm::qa::checker::Hist1DHandler::Hist1DHandler().

◆ ~ObjectHandler()

ObjectHandler::~ObjectHandler ( )

virtual

Destructor.

Definition at line 34 of file CbmQaCheckerObjectHandler.cxx.

References fvpObjects.

Member Function Documentation

◆ AddObjects()

void ObjectHandler::AddObjects ( const std::vector< TNamed * > & vpObj )

Adds vector of pointer to objects.

Parameters

vpObj Vector of pointers to TNamed objects

Definition at line 46 of file CbmQaCheckerObjectHandler.cxx.

References fpObjDB, fpOutDir, fsBaseName, and fvpObjects.

◆ Compare()

virtual Result cbm::qa::checker::ObjectHandler::Compare ( int iVersion ) const

pure virtual

Compares objects to default.

Parameters

iVersion Version index

Returns: Comparison inference

Implemented in cbm::qa::checker::Hist1DHandler, and Hist1DHandler.

Referenced by CompareWithDefault().

◆ CompareWithDefault()

std::vector< Result > ObjectHandler::CompareWithDefault ( )

Compares different versions with default.

Returns: Vector of comparison inferences for different versions

Definition at line 72 of file CbmQaCheckerObjectHandler.cxx.

References Compare(), fpObjDB, fvpObjects, and cbm::qa::checker::StronglyEqual.

◆ CreateCanvases()

virtual void cbm::qa::checker::ObjectHandler::CreateCanvases ( Option_t * )

inlinevirtual

Creates object comparison canvas.

Parameters

opt	Canvas options

Reimplemented in cbm::qa::checker::Hist1DHandler, cbm::qa::checker::Hist2DHandler, cbm::qa::checker::Profile1DHandler, Hist1DHandler, Hist2DHandler, and Profile1DHandler.

Definition at line 51 of file CbmQaCheckerObjectHandler.h.

◆ SetComparisonMethod()

void cbm::qa::checker::ObjectHandler::SetComparisonMethod ( ECmpMethod method )

inline

Sets bit flag to control handler behaviour.

Parameters

bit Bit index

The bit flags should be defined in an enumeration of the default class

Definition at line 74 of file CbmQaCheckerObjectHandler.h.

References fCmpBits.

◆ SetObjectDB()

void cbm::qa::checker::ObjectHandler::SetObjectDB ( std::shared_ptr< ObjectDB > & pObjDB )

inline

Sets objects database.

Parameters

pObjDB Shared pointer to object database

Definition at line 68 of file CbmQaCheckerObjectHandler.h.

References fpObjDB.

◆ SetOutputDirectory()

void ObjectHandler::SetOutputDirectory ( TDirectory * pDir )

Sets folder to store output.

Parameters

pDir	Pointer to folder instance

Definition at line 88 of file CbmQaCheckerObjectHandler.cxx.

References fpOutDir.

◆ Write()

void ObjectHandler::Write ( )

Writes objects to file.

Definition at line 96 of file CbmQaCheckerObjectHandler.cxx.

References fpCanvasCmp, fpCanvasDiff, fpCanvasRat, fpOutDir, and fvpObjects.

Member Data Documentation

◆ fCmpBits

std::bitset<static_cast<size_t>(ECmpMethod::END)> cbm::qa::checker::ObjectHandler::fCmpBits

protected

Bitset for comparison methods.

Definition at line 92 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and SetComparisonMethod().

◆ fDatasetID

int cbm::qa::checker::ObjectHandler::fDatasetID {-1}

protected

Index of dataset.

Definition at line 90 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fFileID

int cbm::qa::checker::ObjectHandler::fFileID {-1}

protected

Index of file.

Definition at line 89 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fObjectID

int cbm::qa::checker::ObjectHandler::fObjectID {-1}

protected

Index of object.

Definition at line 88 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fpCanvasCmp

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasCmp {nullptr}

protected

Comparison canvas: plots together.

Definition at line 84 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpCanvasDiff

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasDiff {nullptr}

protected

Comparison canvas: difference with default.

Definition at line 86 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpCanvasRat

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasRat {nullptr}

protected

Comparison canvas: ratios to default.

Definition at line 85 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpObjDB

std::shared_ptr<ObjectDB> cbm::qa::checker::ObjectHandler::fpObjDB {nullptr}

protected

Pointer to object database.

Definition at line 83 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::Compare(), CompareWithDefault(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and SetObjectDB().

◆ fpOutDir

TDirectory* cbm::qa::checker::ObjectHandler::fpOutDir {nullptr}

protected

Pointer to directory.

Definition at line 87 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), SetOutputDirectory(), and Write().

◆ fsBaseName

std::string cbm::qa::checker::ObjectHandler::fsBaseName {""}

protected

Base names of the object.

Definition at line 81 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), and cbm::qa::checker::Profile1DHandler::CreateCanvases().

◆ fsObjType

std::string cbm::qa::checker::ObjectHandler::fsObjType {""}

protected

Base type of the object to be handled.

Definition at line 80 of file CbmQaCheckerObjectHandler.h.

Referenced by ObjectHandler().

◆ fvpObjects

std::vector<TNamed*> cbm::qa::checker::ObjectHandler::fvpObjects

protected

Vector of objects.

Definition at line 82 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::Compare(), CompareWithDefault(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), Write(), and ~ObjectHandler().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ObjectHandler()

◆ ~ObjectHandler()

Member Function Documentation

◆ AddObjects()

◆ Compare()

◆ CompareWithDefault()

◆ CreateCanvases()

◆ SetComparisonMethod()

◆ SetObjectDB()

◆ SetOutputDirectory()

◆ Write()

Member Data Documentation

◆ fCmpBits

◆ fDatasetID

◆ fFileID

◆ fObjectID

◆ fpCanvasCmp

◆ fpCanvasDiff

◆ fpCanvasRat

◆ fpObjDB

◆ fpOutDir

◆ fsBaseName

◆ fsObjType

◆ fvpObjects