cbm::algo::qa::PadConfig Class Reference

A pad configuration for the histogram server. More...

#include <PadConfig.h>

Public Member Functions
	PadConfig ()=default
	Constructor.
	PadConfig (bool gridX, bool gridY, bool logX, bool logY, bool logZ)
	Constructor from parameters.
	PadConfig (const PadConfig &)=default
	Copy constructor.
	PadConfig (PadConfig &&)=default
	Move constructor.
PadConfig &	operator= (const PadConfig &)=default
	Copy assignment operator.
PadConfig &	operator= (PadConfig &&)=default
	Move assignment operator.
	~PadConfig ()=default
	Destructor.
void	SetGrid (bool gridX, bool gridY=false)
	Set grid flags.
void	SetLog (bool logX, bool logY=false, bool logZ=false)
	Sets logarithm axis.
void	RegisterObject (std::string_view name, std::string_view opt)
	Registers an object in the pad.
template<class Hist >
void	RegisterHistogram (const Hist *hist, std::string_view opt)
	Registers a histogram in the pad.
std::string	ToString () const
	Returns message config.

Private Attributes
bool	fbGridX = false
	Grid flag for x-axis.
bool	fbGridY = false
	Grid flag for y-axis.
bool	fbLogX = false
	Log flag for x-axis.
bool	fbLogY = false
	Log flag for y-axis.
bool	fbLogZ = false
	Log flag for z-axis.
std::vector< std::pair< std::string, std::string > >	fvObjectList
	List of objects on the pad.

Detailed Description

A pad configuration for the histogram server.

The class represents a configuration of the pad, which can be converted in the part of the canvas initialization message for the histogram server.

Definition at line 26 of file PadConfig.h.

Constructor & Destructor Documentation

PadConfig() [1/4]

cbm::algo::qa::PadConfig::PadConfig ( )

default

Constructor.

PadConfig() [2/4]

cbm::algo::qa::PadConfig::PadConfig ( bool gridX, bool gridY, bool logX, bool logY, bool logZ )

inline

Constructor from parameters.

Parameters

gridX
gridY
logX
logY
logZ

Definition at line 37 of file PadConfig.h.

PadConfig() [3/4]

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

default

Copy constructor.

PadConfig() [4/4]

cbm::algo::qa::PadConfig::PadConfig ( PadConfig && )

default

Move constructor.

~PadConfig()

cbm::algo::qa::PadConfig::~PadConfig ( )

default

Destructor.

Member Function Documentation

operator=() [1/2]

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

default

Copy assignment operator.

operator=() [2/2]

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

default

Move assignment operator.

RegisterHistogram()

template<class Hist >

void cbm::algo::qa::PadConfig::RegisterHistogram ( const Hist * hist, std::string_view opt )

inline

Registers a histogram in the pad.

Template Parameters

Hist	Histogram class

Parameters

hist	Histogram object
opt	Draw options for the histogram

If the histogram has EHistFlag::StoreVsTsId, then the TS dependendent histogram will be plotted only. If both integrated and vs. TS histograms are needed, please explicitly provide the histogram names to two separate pads using the RegisterObject function.

Definition at line 91 of file PadConfig.h.

References cbm::algo::qa::HistogramMetadata::ksTsIdSuffix, cbm::algo::qa::OmitIntegrated, RegisterObject(), and cbm::algo::qa::StoreVsTsId.

RegisterObject()

void cbm::algo::qa::PadConfig::RegisterObject ( std::string_view name, std::string_view opt )

inline

Registers an object in the pad.

Parameters

name	Name of the object
opt	Draw options for the object

Definition at line 76 of file PadConfig.h.

References fvObjectList.

Referenced by RegisterHistogram().

SetGrid()

void PadConfig::SetGrid	(	bool	gridX,
		bool	gridY = false )

Set grid flags.

Parameters

gridX	Flag for x-axis
gridY	Flag for y-axis

Definition at line 20 of file PadConfig.cxx.

References fbGridX, and fbGridY.

SetLog()

void PadConfig::SetLog	(	bool	logX,
		bool	logY = false,
		bool	logZ = false )

Sets logarithm axis.

Parameters

logX	Logarithm flag for x-axis
logY	Logarithm flag for y-axis
logZ	Logarithm flag for z-axis

Definition at line 28 of file PadConfig.cxx.

References fbLogX, fbLogY, and fbLogZ.

ToString()

std::string PadConfig::ToString

(

)

const

Returns message config.

Definition at line 37 of file PadConfig.cxx.

References fbGridX, fbGridY, fbLogX, fbLogY, fbLogZ, fvObjectList, and L_.

Referenced by cbm::algo::qa::CanvasConfig::AddPadConfig().

Member Data Documentation

fbGridX

bool cbm::algo::qa::PadConfig::fbGridX = false

private

Grid flag for x-axis.

Definition at line 107 of file PadConfig.h.

Referenced by SetGrid(), and ToString().

fbGridY

bool cbm::algo::qa::PadConfig::fbGridY = false

private

Grid flag for y-axis.

Definition at line 108 of file PadConfig.h.

Referenced by SetGrid(), and ToString().

fbLogX

bool cbm::algo::qa::PadConfig::fbLogX = false

private

Log flag for x-axis.

Definition at line 109 of file PadConfig.h.

Referenced by SetLog(), and ToString().

fbLogY

bool cbm::algo::qa::PadConfig::fbLogY = false

private

Log flag for y-axis.

Definition at line 110 of file PadConfig.h.

Referenced by SetLog(), and ToString().

fbLogZ

bool cbm::algo::qa::PadConfig::fbLogZ = false

private

Log flag for z-axis.

Definition at line 111 of file PadConfig.h.

Referenced by SetLog(), and ToString().

fvObjectList

std::vector<std::pair<std::string, std::string> > cbm::algo::qa::PadConfig::fvObjectList

private

List of objects on the pad.

Definition at line 113 of file PadConfig.h.

Referenced by RegisterObject(), and ToString().

---

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

• PadConfig.h
• PadConfig.cxx