Class to handle QA-objects in the online reconstruction. More...

#include <QaData.h>

Collaboration diagram for cbm::algo::qa::Data:

Public Member Functions
	Data ()=default
	Default constructor.

	Data (std::string_view name)
	Constructor.

	Data (const Data &)=default
	Copy constructor.

	Data (Data &&)=default
	Move constructor.

Data &	operator= (const Data &)=default
	Copy assignment operator.

Data &	operator= (Data &&)=default
	Move assignment operator.

	~Data ()=default
	Destructor.

void	AddCanvasConfig (const CanvasConfig &canvas)
	Adds a canvas to the canvas config list.

const HistogramContainer &	Histograms () const
	Constant accessor to the histogram container.

void	Init (std::shared_ptr< HistogramSender > histoSender)
	Sends QA initialization information to the HistogramSender.

template<class Obj, typename... Args>
Obj *	MakeObj (Args... args)
	Creates a QA-object and returns the pointer to it.

void	Reset ()
	Resets the histograms.

void	Send (std::shared_ptr< HistogramSender > histoSender)
	Sends QA data to the HistogramSender.

void	SetTimesliceId (uint64_t timesliceId)
	Updates the timeslice index.

void	SetTimesliceTimeInRun (uint64_t timesliceTime)
	Updates the timeslice start time relative to run start time.

void	RegisterNewTask (std::string_view name)
	Registers a new QA task.

Private Attributes
qa::HistogramContainer	fHistograms
	A container of histograms, which forms a zmq message.

std::string	fsTaskNames
	A string containing names of tasks.

std::vector< qa::TaskProperties >	fvTaskProperties
	A vector to store properties for multiple QA-tasks.

std::vector< std::string >	fvsCanvCfgs = {}
	Vector of canvas configs.

uint32_t	fNofH1 {0}
	Number of 1D-histograms.

uint32_t	fNofH2 {0}
	Number of 2D-histograms.

uint32_t	fNofP1 {0}
	Number of 1D-profiles.

uint32_t	fNofP2 {0}
	Number of 2D-profiles.

bool	fbNotEmpty {true}
	false: if no histograms were provided, do not perform initialization and sending

Detailed Description

Class to handle QA-objects in the online reconstruction.

Definition at line 27 of file QaData.h.

Constructor & Destructor Documentation

◆ Data() [1/4]

cbm::algo::qa::Data::Data ( )

default

Default constructor.

Referenced by Data(), Data(), operator=(), and operator=().

◆ Data() [2/4]

cbm::algo::qa::Data::Data ( std::string_view name )

inline

Constructor.

Parameters

name	Name of the QA module (appears as the directory name in the output)

Definition at line 34 of file QaData.h.

References RegisterNewTask().

◆ Data() [3/4]

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

default

Copy constructor.

References Data().

◆ Data() [4/4]

cbm::algo::qa::Data::Data ( Data && )

default

Move constructor.

References Data().

◆ ~Data()

cbm::algo::qa::Data::~Data ( )

default

Destructor.

Member Function Documentation

◆ AddCanvasConfig()

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

inline

Adds a canvas to the canvas config list.

Parameters

canvas A CanvasConfig object

Definition at line 53 of file QaData.h.

References fvsCanvCfgs, and cbm::algo::qa::CanvasConfig::ToString().

◆ Histograms()

const HistogramContainer & cbm::algo::qa::Data::Histograms ( ) const

inline

Constant accessor to the histogram container.

Definition at line 56 of file QaData.h.

References fHistograms.

Referenced by cbm::algo::qa::StorableData::StorableData().

◆ Init()

void Data::Init ( std::shared_ptr< HistogramSender > histoSender )

Sends QA initialization information to the HistogramSender.

Parameters

histoSender A pointer to the histogram sender

Definition at line 19 of file QaData.cxx.

References fbNotEmpty, fHistograms, fNofH1, fNofH2, fNofP1, fNofP2, fsTaskNames, fvsCanvCfgs, fvTaskProperties, L_, and task.

◆ MakeObj()

template<class Obj, typename... Args>

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

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 105 of file QaData.h.

References fHistograms, fNofH1, fNofH2, fNofP1, fNofP2, and fvTaskProperties.

◆ operator=() [1/2]

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

default

Copy assignment operator.

References Data().

◆ operator=() [2/2]

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

default

Move assignment operator.

References Data().

◆ RegisterNewTask()

void Data::RegisterNewTask ( std::string_view name )

Registers a new QA task.

Parameters

name	Name of the task

Definition at line 118 of file QaData.cxx.

References fHistograms, and fvTaskProperties.

Referenced by Data().

◆ Reset()

void cbm::algo::qa::Data::Reset ( )

inline

Resets the histograms.

Definition at line 70 of file QaData.h.

References fHistograms.

Referenced by Send().

◆ Send()

void Data::Send ( std::shared_ptr< HistogramSender > histoSender )

Sends QA data to the HistogramSender.

Parameters

histoSender A pointer to the histogram sender

Note: Calls this->Reset() after sending the message to the histogram server

Definition at line 133 of file QaData.cxx.

References fbNotEmpty, fHistograms, fNofH1, fNofH2, fNofP1, fNofP2, fsTaskNames, L_, and Reset().

◆ SetTimesliceId()

void cbm::algo::qa::Data::SetTimesliceId ( uint64_t timesliceId )

inline

Updates the timeslice index.

Parameters

timesliceId Timeslice index

Definition at line 79 of file QaData.h.

References fHistograms.

◆ SetTimesliceTimeInRun()

void cbm::algo::qa::Data::SetTimesliceTimeInRun ( uint64_t timesliceTime )

inline

Updates the timeslice start time relative to run start time.

Parameters

timesliceTime Timeslice start time relative to run start time, in seconds

Definition at line 83 of file QaData.h.

References fHistograms.

Member Data Documentation

◆ fbNotEmpty

bool cbm::algo::qa::Data::fbNotEmpty {true}

private

false: if no histograms were provided, do not perform initialization and sending

Definition at line 99 of file QaData.h.

Referenced by Init(), and Send().

◆ fHistograms

qa::HistogramContainer cbm::algo::qa::Data::fHistograms

private

A container of histograms, which forms a zmq message.

Definition at line 90 of file QaData.h.

Referenced by Histograms(), Init(), MakeObj(), RegisterNewTask(), Reset(), Send(), SetTimesliceId(), and SetTimesliceTimeInRun().

◆ fNofH1

uint32_t cbm::algo::qa::Data::fNofH1 {0}

private

Number of 1D-histograms.

Definition at line 95 of file QaData.h.

Referenced by Init(), MakeObj(), and Send().

◆ fNofH2

uint32_t cbm::algo::qa::Data::fNofH2 {0}

private

Number of 2D-histograms.

Definition at line 96 of file QaData.h.

Referenced by Init(), MakeObj(), and Send().

◆ fNofP1

uint32_t cbm::algo::qa::Data::fNofP1 {0}

private

Number of 1D-profiles.

Definition at line 97 of file QaData.h.

Referenced by Init(), MakeObj(), and Send().

◆ fNofP2

uint32_t cbm::algo::qa::Data::fNofP2 {0}

private

Number of 2D-profiles.

Definition at line 98 of file QaData.h.

Referenced by Init(), MakeObj(), and Send().

◆ fsTaskNames

std::string cbm::algo::qa::Data::fsTaskNames

private

A string containing names of tasks.

Definition at line 91 of file QaData.h.

Referenced by Init(), and Send().

◆ fvsCanvCfgs

std::vector<std::string> cbm::algo::qa::Data::fvsCanvCfgs = {}

private

Vector of canvas configs.

Definition at line 93 of file QaData.h.

Referenced by AddCanvasConfig(), and Init().

◆ fvTaskProperties

std::vector<qa::TaskProperties> cbm::algo::qa::Data::fvTaskProperties

private

A vector to store properties for multiple QA-tasks.

Definition at line 92 of file QaData.h.

Referenced by Init(), MakeObj(), and RegisterNewTask().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Data() [1/4]

◆ Data() [2/4]

◆ Data() [3/4]

◆ Data() [4/4]

◆ ~Data()

Member Function Documentation

◆ AddCanvasConfig()

◆ Histograms()

◆ Init()

◆ MakeObj()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RegisterNewTask()

◆ Reset()

◆ Send()

◆ SetTimesliceId()

◆ SetTimesliceTimeInRun()

Member Data Documentation

◆ fbNotEmpty

◆ fHistograms

◆ fNofH1

◆ fNofH2

◆ fNofP1

◆ fNofP2

◆ fsTaskNames

◆ fvsCanvCfgs

◆ fvTaskProperties