CbmQaManager Class Reference

#include <CbmQaManager.h>

Inheritance diagram for CbmQaManager:

Collaboration diagram for CbmQaManager:

Public Member Functions
	CbmQaManager (int verbose=1)
	Constructor from parameters.
virtual	~CbmQaManager ()=default
	Destructor.
	CbmQaManager (const CbmQaManager &)=delete
	Copy constructor.
	CbmQaManager (CbmQaManager &&)=delete
	Move constructor.
CbmQaManager &	operator= (const CbmQaManager &)=delete
	Copy assignment operator.
CbmQaManager &	operator= (CbmQaManager &&)=delete
	Move assignment operator.
void	AddTask (FairTask *task)
	Adds sub-task.
void	Exec (Option_t *)
	Action of the task in the time-slice.
void	Finish ()
	Action of the task in the end of the run.
bool	GetStatus () const
	Gets status flag.
const TString &	GetConfigName () const
	Gets YAML config name.
const TString &	GetDefaultTag () const
	Gets default tag.
const TString &	GetVersionTag () const
	Gets version tag.
InitStatus	Init ()
	Task initialization.
InitStatus	ReInit ()
	Task re-initialization.
	ClassDef (CbmQaManager, 0)
void	OpenBenchmarkInput (const TString &path)
	Open cross-check file.
void	OpenBenchmarkOutput (const TString &path)
	Open benchmark output file.
void	SetConfigName (const TString &name)
	Sets YAML config name.
void	SetVersionTag (const TString &tag)
	Sets version tag.
void	SetDefaultTag (const TString &tag)
	Sets default tag.

Private Attributes
bool	fStatus = true
	Status of QA: true - all tasks passed, false - at least one of the task failed.
TString	fsConfigName = ""
	Name of the configuration YAML file (passed to underlying QA tasks)
TString	fsVersionTag = ""
	Version tag (git SHA etc.)
TString	fsDefaultTag = ""
	Default tag (git SHA etc.)
std::shared_ptr< TFile >	fpBenchmarkInput
	A benchmark file with default ROOT objects used for the cross-check.
std::shared_ptr< TFile >	fpBenchmarkOutput = nullptr
	An output file for histograms cross-check.

Detailed Description

Definition at line 20 of file CbmQaManager.h.

Constructor & Destructor Documentation

CbmQaManager() [1/3]

CbmQaManager::CbmQaManager

(

int

verbose = 1

)

Constructor from parameters.

Parameters

verbose

Verbose level

Definition at line 19 of file CbmQaManager.cxx.

~CbmQaManager()

virtual CbmQaManager::~CbmQaManager ( )

virtualdefault

Destructor.

CbmQaManager() [2/3]

CbmQaManager::CbmQaManager ( const CbmQaManager & )

delete

Copy constructor.

CbmQaManager() [3/3]

CbmQaManager::CbmQaManager ( CbmQaManager && )

delete

Move constructor.

Member Function Documentation

AddTask()

void CbmQaManager::AddTask ( FairTask * task )

inline

Adds sub-task.

Definition at line 42 of file CbmQaManager.h.

References Add().

ClassDef()

CbmQaManager::ClassDef	(	CbmQaManager	,
		0	)

Exec()

void CbmQaManager::Exec ( Option_t * )

inline

Action of the task in the time-slice.

Definition at line 45 of file CbmQaManager.h.

Finish()

void CbmQaManager::Finish

(

)

Action of the task in the end of the run.

Definition at line 24 of file CbmQaManager.cxx.

References fpBenchmarkInput, fpBenchmarkOutput, fStatus, and task.

GetConfigName()

const TString & CbmQaManager::GetConfigName ( ) const

inline

Gets YAML config name.

Definition at line 54 of file CbmQaManager.h.

References fsConfigName.

GetDefaultTag()

const TString & CbmQaManager::GetDefaultTag ( ) const

inline

Gets default tag.

Definition at line 57 of file CbmQaManager.h.

References fsDefaultTag.

GetStatus()

bool CbmQaManager::GetStatus ( ) const

inline

Gets status flag.

Definition at line 51 of file CbmQaManager.h.

References fStatus.

GetVersionTag()

const TString & CbmQaManager::GetVersionTag ( ) const

inline

Gets version tag.

Definition at line 60 of file CbmQaManager.h.

References fsVersionTag.

Init()

InitStatus CbmQaManager::Init

(

)

Task initialization.

Definition at line 76 of file CbmQaManager.cxx.

References fpBenchmarkInput, fpBenchmarkOutput, fsConfigName, fsDefaultTag, fsVersionTag, and task.

Referenced by ReInit().

OpenBenchmarkInput()

void CbmQaManager::OpenBenchmarkInput

(

const TString &

path

)

Open cross-check file.

Parameters

path	Path to the cross-check file

Opens the benchmark input ROOT-file with the QA-chain output, obtained under the default code base.

Definition at line 101 of file CbmQaManager.cxx.

References fpBenchmarkInput.

OpenBenchmarkOutput()

void CbmQaManager::OpenBenchmarkOutput

(

const TString &

path

)

Open benchmark output file.

Parameters

path	Path to the comparison output

Definition at line 117 of file CbmQaManager.cxx.

References fpBenchmarkOutput.

operator=() [1/2]

CbmQaManager & CbmQaManager::operator= ( CbmQaManager && )

delete

Move assignment operator.

operator=() [2/2]

CbmQaManager & CbmQaManager::operator= ( const CbmQaManager & )

delete

Copy assignment operator.

ReInit()

InitStatus CbmQaManager::ReInit ( )

inline

Task re-initialization.

Definition at line 66 of file CbmQaManager.h.

References Init().

SetConfigName()

void CbmQaManager::SetConfigName ( const TString & name )

inline

Sets YAML config name.

Definition at line 81 of file CbmQaManager.h.

References fsConfigName.

SetDefaultTag()

void CbmQaManager::SetDefaultTag ( const TString & tag )

inline

Sets default tag.

Definition at line 87 of file CbmQaManager.h.

References fsDefaultTag.

SetVersionTag()

void CbmQaManager::SetVersionTag ( const TString & tag )

inline

Sets version tag.

Definition at line 84 of file CbmQaManager.h.

References fsVersionTag.

Member Data Documentation

fpBenchmarkInput

std::shared_ptr<TFile> CbmQaManager::fpBenchmarkInput

private

Initial value:

=
    nullptr

A benchmark file with default ROOT objects used for the cross-check.

Definition at line 95 of file CbmQaManager.h.

Referenced by Finish(), Init(), and OpenBenchmarkInput().

fpBenchmarkOutput

std::shared_ptr<TFile> CbmQaManager::fpBenchmarkOutput = nullptr

private

An output file for histograms cross-check.

Definition at line 97 of file CbmQaManager.h.

Referenced by Finish(), Init(), and OpenBenchmarkOutput().

fsConfigName

TString CbmQaManager::fsConfigName = ""

private

Name of the configuration YAML file (passed to underlying QA tasks)

Definition at line 91 of file CbmQaManager.h.

Referenced by GetConfigName(), Init(), and SetConfigName().

fsDefaultTag

TString CbmQaManager::fsDefaultTag = ""

private

Default tag (git SHA etc.)

Definition at line 93 of file CbmQaManager.h.

Referenced by GetDefaultTag(), Init(), and SetDefaultTag().

fStatus

bool CbmQaManager::fStatus = true

private

Status of QA: true - all tasks passed, false - at least one of the task failed.

Definition at line 90 of file CbmQaManager.h.

Referenced by Finish(), and GetStatus().

fsVersionTag

TString CbmQaManager::fsVersionTag = ""

private

Version tag (git SHA etc.)

Definition at line 92 of file CbmQaManager.h.

Referenced by GetVersionTag(), Init(), and SetVersionTag().

---

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

• CbmQaManager.h
• CbmQaManager.cxx