A central class to manage the histogram storage and sending to the histogram server. More...

#include <QaManager.h>

Inheritance diagram for cbm::algo::qa::Manager:

Collaboration diagram for cbm::algo::qa::Manager:

Public Member Functions
	Manager (std::shared_ptr< HistogramSender > histoSender=nullptr)
	Constructor.

	Manager (const Manager &)=delete
	Copy constructor.

	Manager (Manager &&)=delete
	Move constructor.

	~Manager ()=default
	Destructor.

Manager &	operator= (const Manager &)=delete
	Copy assignment operator.

Manager &	operator= (Manager &&)=delete
	Move assignment operator.

std::shared_ptr< Data >	GetData () const
	Gets an instance of QA data.

void	Init ()
	Initializes the instance and sends the histogram and canvas configuration to the server.

void	SendHistograms ()
	Sends a collection of histograms to the server.

void	SetTimesliceId (uint64_t timesliceId)
	Sets a timeslice index.

void	WriteHistograms (const std::string &filename, bool compress) const
	Writes histograms.

void	SetTimesliceTimeInRun (uint64_t timesliceTime)
	Sets a timeslice start time relative to run start time.

const ChainContext *	GetContext ()

void	SetContext (const ChainContext *ctx)

const Options &	Opts () const

const RecoParams &	Params () const

bool	HasMonitor () const

Monitor &	GetMonitor () const

Private Attributes
std::shared_ptr< HistogramSender >	fpSender {nullptr}
	Histogram sender.

std::shared_ptr< Data >	fpData {std::make_shared<Data>()}
	Instance of QA Data.

const ChainContext *	fContext = nullptr

Detailed Description

A central class to manage the histogram storage and sending to the histogram server.

Definition at line 20 of file QaManager.h.

Constructor & Destructor Documentation

◆ Manager() [1/3]

Manager::Manager ( std::shared_ptr< HistogramSender > histoSender = nullptr )

Constructor.

Parameters

histoSender A histogram sender instance

Definition at line 20 of file QaManager.cxx.

References fpSender.

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

◆ Manager() [2/3]

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

delete

Copy constructor.

References Manager().

◆ Manager() [3/3]

cbm::algo::qa::Manager::Manager ( Manager && )

delete

Move constructor.

References Manager().

◆ ~Manager()

cbm::algo::qa::Manager::~Manager ( )

default

Destructor.

Member Function Documentation

◆ GetContext()

const ChainContext * cbm::algo::SubChain::GetContext ( )

inlineinherited

Definition at line 16 of file SubChain.h.

References fContext.

◆ GetData()

std::shared_ptr< Data > cbm::algo::qa::Manager::GetData ( ) const

inline

Gets an instance of QA data.

Definition at line 42 of file QaManager.h.

References fpData.

◆ GetMonitor()

Monitor & cbm::algo::SubChain::GetMonitor ( ) const

inlineinherited

Definition at line 25 of file SubChain.h.

References fContext, and HasMonitor().

Referenced by cbm::algo::Reco::QueueEvbuildMetrics(), cbm::algo::Reco::QueueProcessingExtraMetrics(), cbm::algo::Reco::QueueProcessingMetrics(), cbm::algo::Reco::QueueStsRecoMetrics(), cbm::algo::Reco::QueueTofCalibMetrics(), cbm::algo::Reco::QueueTofRecoMetrics(), cbm::algo::Reco::QueueTrackingMetrics(), cbm::algo::Reco::QueueTrdRecoMetrics(), and cbm::algo::Reco::QueueUnpackerMetricsDet().

◆ HasMonitor()

bool cbm::algo::SubChain::HasMonitor ( ) const

inlineinherited

Definition at line 23 of file SubChain.h.

References fContext.

Referenced by GetMonitor(), cbm::algo::Reco::QueueEvbuildMetrics(), cbm::algo::Reco::QueueProcessingExtraMetrics(), cbm::algo::Reco::QueueProcessingMetrics(), cbm::algo::Reco::QueueStsRecoMetrics(), cbm::algo::Reco::QueueTofCalibMetrics(), cbm::algo::Reco::QueueTofRecoMetrics(), cbm::algo::Reco::QueueTrackingMetrics(), cbm::algo::Reco::QueueTrdRecoMetrics(), and cbm::algo::Reco::QueueUnpackerMetricsDet().

◆ Init()

void Manager::Init ( )

Initializes the instance and sends the histogram and canvas configuration to the server.

Definition at line 24 of file QaManager.cxx.

References fpData, and fpSender.

◆ operator=() [1/2]

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

delete

Copy assignment operator.

References Manager().

◆ operator=() [2/2]

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

delete

Move assignment operator.

References Manager().

◆ Opts()

const Options & cbm::algo::SubChain::Opts ( ) const

inlineinherited

Definition at line 20 of file SubChain.h.

References fContext.

◆ Params()

const RecoParams & cbm::algo::SubChain::Params ( ) const

inlineinherited

Definition at line 21 of file SubChain.h.

References fContext.

Referenced by cbm::algo::Reco::Init(), cbm::algo::sts::HitfinderChain::operator()(), and cbm::algo::Reco::Run().

◆ SendHistograms()

void Manager::SendHistograms ( )

Sends a collection of histograms to the server.

Note: Resets the histograms after sending them

Definition at line 28 of file QaManager.cxx.

References fpData, and fpSender.

◆ SetContext()

void cbm::algo::SubChain::SetContext ( const ChainContext * ctx )

inlineinherited

Definition at line 18 of file SubChain.h.

References fContext.

Referenced by cbm::algo::Reco::Init().

◆ SetTimesliceId()

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

inline

Sets a timeslice index.

Parameters

timesliceId A timeslice index

Definition at line 53 of file QaManager.h.

References fpData.

◆ SetTimesliceTimeInRun()

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

inline

Sets a timeslice start time relative to run start time.

Parameters

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

Definition at line 65 of file QaManager.h.

References fpData.

◆ WriteHistograms()

void Manager::WriteHistograms	(	const std::string &	filename,
		bool	compress ) const

Writes histograms.

Parameters

filename	Name of the output file
compress	Use a compression

Note: Since the histogram container is reset every time when the histograms are sent to the histogram server, writing the histograms makes no sense with the latter is connected to the Reco. So, the storing of the histograms will be ignored in this case.

Definition at line 32 of file QaManager.cxx.

References fpData, fpSender, and L_.

Member Data Documentation

◆ fContext

const ChainContext* cbm::algo::SubChain::fContext = nullptr

privateinherited

Definition at line 34 of file SubChain.h.

Referenced by GetContext(), GetMonitor(), HasMonitor(), Opts(), Params(), and SetContext().

◆ fpData

std::shared_ptr<Data> cbm::algo::qa::Manager::fpData {std::make_shared<Data>()}

private

Instance of QA Data.

Definition at line 69 of file QaManager.h.

Referenced by GetData(), Init(), SendHistograms(), SetTimesliceId(), SetTimesliceTimeInRun(), and WriteHistograms().

◆ fpSender

std::shared_ptr<HistogramSender> cbm::algo::qa::Manager::fpSender {nullptr}

private

Histogram sender.

Definition at line 68 of file QaManager.h.

Referenced by Init(), Manager(), SendHistograms(), and WriteHistograms().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Manager() [1/3]

◆ Manager() [2/3]

◆ Manager() [3/3]

◆ ~Manager()

Member Function Documentation

◆ GetContext()

◆ GetData()

◆ GetMonitor()

◆ HasMonitor()

◆ Init()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Opts()

◆ Params()

◆ SendHistograms()

◆ SetContext()

◆ SetTimesliceId()

◆ SetTimesliceTimeInRun()

◆ WriteHistograms()

Member Data Documentation

◆ fContext

◆ fpData

◆ fpSender