cbm::algo::qa::TaskHeader Class Reference

An interface to the qa::Manager. More...

#include <QaTaskHeader.h>

Inheritance diagram for cbm::algo::qa::TaskHeader:

Collaboration diagram for cbm::algo::qa::TaskHeader:

Public Member Functions
	TaskHeader (const std::unique_ptr< Manager > &pManager, std::string_view name)
	Constructor.
	TaskHeader (const TaskHeader &)=delete
	Copy constructor.
	TaskHeader (TaskHeader &&)=delete
	Move constructor.
	~TaskHeader ()=default
	Destructor.
TaskHeader &	operator= (const TaskHeader &)=delete
	Copy assignment operator.
TaskHeader &	operator= (TaskHeader &&)=delete
	Move assignment operator.
bool	IsActive () const
	Checks, if the task is active.
const std::string &	GetTaskName ()
	Gets name of the task.

Protected Member Functions
void	AddCanvasConfig (const CanvasConfig &canvas)
	Adds a canvas configuration.
template<class Obj , typename... Args>
Obj *	MakeObj (Args... args)
	Creates a QA-object and returns the pointer to it.

Private Attributes
std::string	fsName {}
	Name of the task.
std::shared_ptr< Data >	fpData {nullptr}
	An instance of the QA data (shared between different tasks)

Detailed Description

An interface to the qa::Manager.

Note

Must be inherited by a QA task

Definition at line 21 of file QaTaskHeader.h.

Constructor & Destructor Documentation

TaskHeader() [1/3]

cbm::algo::qa::TaskHeader::TaskHeader ( const std::unique_ptr< Manager > & pManager, std::string_view name )

inline

Constructor.

Parameters

pManager	a QA-manager
name	A name of the task (histograms directory)

Definition at line 26 of file QaTaskHeader.h.

References fpData.

TaskHeader() [2/3]

cbm::algo::qa::TaskHeader::TaskHeader ( const TaskHeader & )

delete

Copy constructor.

TaskHeader() [3/3]

cbm::algo::qa::TaskHeader::TaskHeader ( TaskHeader && )

delete

Move constructor.

~TaskHeader()

cbm::algo::qa::TaskHeader::~TaskHeader ( )

default

Destructor.

Member Function Documentation

AddCanvasConfig()

void cbm::algo::qa::TaskHeader::AddCanvasConfig ( const CanvasConfig & canvas )

inlineprotected

Adds a canvas configuration.

Parameters

canvas

A CanvasConfig object

Definition at line 62 of file QaTaskHeader.h.

References fpData.

Referenced by cbm::algo::bmon::HitfindQa::Init(), cbm::algo::ca::Qa::Init(), cbm::algo::evbuild::V0TriggerQa::Init(), cbm::algo::kfp::V0FinderQa::Init(), and cbm::algo::tof::HitfindQa::Init().

GetTaskName()

const std::string & cbm::algo::qa::TaskHeader::GetTaskName ( )

inline

Gets name of the task.

Definition at line 57 of file QaTaskHeader.h.

References fsName.

Referenced by cbm::algo::bmon::HitfindQa::Init(), cbm::algo::ca::Qa::Init(), cbm::algo::evbuild::V0TriggerQa::Init(), and cbm::algo::tof::HitfindQa::Init().

IsActive()

bool cbm::algo::qa::TaskHeader::IsActive ( ) const

inline

Checks, if the task is active.

The task can be inactive, if a nullptr qa::Manager was passed to the constructor. If it is the case, the fpData instance is not defined, and no actions on the task should be performed

Definition at line 54 of file QaTaskHeader.h.

References fpData.

Referenced by cbm::algo::bmon::HitfindQa::Exec(), cbm::algo::ca::Qa::Exec(), cbm::algo::tof::HitfindQa::Exec(), cbm::algo::bmon::HitfindQa::Init(), cbm::algo::ca::Qa::Init(), cbm::algo::tof::HitfindQa::Init(), cbm::algo::TrackingChain::Init(), and cbm::algo::TrackingChain::PrepareOutput().

MakeObj()

template<class Obj , typename... Args>

Obj * cbm::algo::qa::TaskHeader::MakeObj ( Args... args )

inlineprotected

Creates a QA-object and returns the pointer to it.

Template Parameters

Obj	A type of the histogram (H1D, H2D, Prof1D, Prof2D)
Args...	A signature of the histogram constructor

Parameters

args	Parameters, passed to a histogram constructor

Definition at line 69 of file QaTaskHeader.h.

References fpData.

Referenced by cbm::algo::bmon::HitfindQa::Init(), cbm::algo::ca::Qa::Init(), cbm::algo::evbuild::V0TriggerQa::Init(), cbm::algo::kfp::V0FinderQa::Init(), and cbm::algo::tof::HitfindQa::Init().

operator=() [1/2]

TaskHeader & cbm::algo::qa::TaskHeader::operator= ( const TaskHeader & )

delete

Copy assignment operator.

operator=() [2/2]

TaskHeader & cbm::algo::qa::TaskHeader::operator= ( TaskHeader && )

delete

Move assignment operator.

Member Data Documentation

fpData

std::shared_ptr<Data> cbm::algo::qa::TaskHeader::fpData {nullptr}

private

An instance of the QA data (shared between different tasks)

Definition at line 76 of file QaTaskHeader.h.

Referenced by AddCanvasConfig(), IsActive(), MakeObj(), and TaskHeader().

fsName

std::string cbm::algo::qa::TaskHeader::fsName {}

private

Name of the task.

Definition at line 75 of file QaTaskHeader.h.

Referenced by GetTaskName().

---

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

• QaTaskHeader.h