Base class for study reports. More...

#include <CbmStudyReport.h>

Inheritance diagram for CbmStudyReport:

Collaboration diagram for CbmStudyReport:

Public Member Functions
	CbmStudyReport ()
	Constructor. More...

virtual	~CbmStudyReport ()
	Destructor. More...

void	Create (const std::vector< CbmHistManager * > &histManagers, const std::vector< std::string > &studyNames, const std::string &outputDir)
	Main function which creates report data. More...

void	Create (const std::vector< std::string > &fileNames, const std::vector< std::string > &studyNames, const std::string &outputDir)
	Main function which creates report data. More...

virtual void	Create ()=0
	Inherited from CbmReport. Pure abstract function which is called from public Create() function. More...

const std::vector< CbmHistManager * > &	HM () const

CbmHistManager *	HM (Int_t index) const

const std::vector< std::string > &	GetStudyNames () const

const std::string &	GetStudyName (Int_t index) const

const CbmReportElement *	R () const
	Accessor to CbmReportElement object. User has to write the report using available tags from CbmReportElement class. More...

std::ostream &	Out () const
	All text output goes to this stream. More...

void	SetReportName (const std::string &name)

void	SetReportTitle (const std::string &title)

void	SetOutputDir (const std::string &outputDir)

const std::string &	GetReportName () const

const std::string &	GetReportTitle () const

const std::string &	GetOutputDir () const

Protected Member Functions
virtual void	Draw ()=0
	Pure abstract function which is called from public Create() function. This function has to draw all necessary histograms and graphs. It is called only once before report creation. More...

void	Draw (Option_t *)
	Inherited from TObject. This method is implemented in order to avoid warnings. More...

void	CreateReports ()
	Create all available report types. More...

TCanvas *	CreateCanvas (const char name, const char title, Int_t ww, Int_t wh)
	Create canvas and put it to vector of TCanvases. Canvases created with this function will be automatically saved to image and printed in the report. More...

void	SaveCanvasesAsImages () const
	Save all canvases to images. More...

void	WriteCanvases () const
	Write canvases to file. More...

void	PrintCanvases () const
	Print images created from canvases in the report. More...

Private Member Functions
void	CreateReportElement (ReportType reportType)
	Create concrete CbmReportElement instance based on report type. More...

void	DeleteReportElement ()
	Delete report element. Normally should be called at the end of Create function. More...

Private Attributes
std::vector< CbmHistManager * >	fHM

std::vector< std::string >	fStudyNames

std::string	fReportName

std::string	fReportTitle

std::string	fOutputDir

ReportType	fReportType

CbmReportElement *	fR

std::ostream *	fOut

std::vector< TCanvas * >	fCanvases

Detailed Description

Base class for study reports.

Author: Semen Lebedev s.leb.nosp@m.edev.nosp@m.@gsi..nosp@m.de

Date: 2011

Definition at line 26 of file CbmStudyReport.h.

Constructor & Destructor Documentation

◆ CbmStudyReport()

CbmStudyReport::CbmStudyReport ( )

Constructor.

Definition at line 22 of file CbmStudyReport.cxx.

◆ ~CbmStudyReport()

CbmStudyReport::~CbmStudyReport ( )

virtual

Destructor.

Definition at line 24 of file CbmStudyReport.cxx.

Member Function Documentation

◆ Create() [1/3]

virtual void CbmStudyReport::Create ( )

pure virtual

Inherited from CbmReport. Pure abstract function which is called from public Create() function.

Implements CbmReport.

Implemented in CbmRichGeoTestStudyReport, CbmLitTrackingQaStudyReport, CbmLitClusteringQaStudyReport, CbmLitFitQaStudyReport, and CbmAnaDielectronStudyReportAll.

◆ Create() [2/3]

void CbmStudyReport::Create	(	const std::vector< CbmHistManager * > &	histManagers,
		const std::vector< std::string > &	studyNames,
		const std::string &	outputDir
	)

Main function which creates report data.

Non virtual interface pattern is used here. User always creates simulation report using this public non virtual method. In order to configure concrete report generation class user has to implement protected Create() method and getters for the file names.

Parameters

[in]	histManagers	Array of histogram managers for which report is created.
[in]	studyNames	Names of studies.
[in]	outputDir	name of the output directory.

Referenced by CbmAnaDielectronReports::CreateStudyReport().

◆ Create() [3/3]

void CbmStudyReport::Create	(	const std::vector< std::string > &	fileNames,
		const std::vector< std::string > &	studyNames,
		const std::string &	outputDir
	)

Main function which creates report data.

Same pattern is used here.

Parameters

[in]	fileNames	Array of file names for which report is created.
[in]	studyNames	Names of studies.
[in]	outputDir	name of the output directory.

◆ CreateCanvas()

TCanvas * CbmReport::CreateCanvas	(	const char *	name,
		const char *	title,
		Int_t	ww,
		Int_t	wh
	)

protectedinherited

Create canvas and put it to vector of TCanvases. Canvases created with this function will be automatically saved to image and printed in the report.

Definition at line 82 of file CbmReport.cxx.

References CbmReport::fCanvases.

◆ CreateReportElement()

void CbmReport::CreateReportElement ( ReportType reportType )

privateinherited

Create concrete CbmReportElement instance based on report type.

Parameters

[in] reportType Type of the report to be produced.

Definition at line 36 of file CbmReport.cxx.

References CbmReport::fOut, CbmReport::fR, CbmReport::fReportName, CbmReport::fReportType, CbmReport::GetOutputDir(), kCoutReport, kHtmlReport, kLatexReport, and kTextReport.

Referenced by CbmReport::CreateReports().

◆ CreateReports()

void CbmReport::CreateReports ( )

protectedinherited

Create all available report types.

Definition at line 60 of file CbmReport.cxx.

References CbmReport::Create(), CbmReport::CreateReportElement(), CbmReport::DeleteReportElement(), CbmReport::Draw(), kCoutReport, kHtmlReport, kLatexReport, kTextReport, and CbmReport::SaveCanvasesAsImages().

◆ DeleteReportElement()

void CbmReport::DeleteReportElement ( )

privateinherited

Delete report element. Normally should be called at the end of Create function.

Definition at line 55 of file CbmReport.cxx.

Referenced by CbmReport::CreateReports().

◆ Draw() [1/2]

virtual void CbmReport::Draw ( )

protectedpure virtualinherited

Pure abstract function which is called from public Create() function. This function has to draw all necessary histograms and graphs. It is called only once before report creation.

Implemented in CbmRichGeoTestStudyReport, CbmLitTrackingQaStudyReport, CbmLitClusteringQaReport, CbmLitRadLengthQaReport, CbmLitTrackingQaReport, CbmLitClusteringQaStudyReport, CbmLitFitQaReport, CbmLitFitQaStudyReport, CbmLitFieldQaReport, CbmLitFieldApproximationQaReport, CbmLitTofQaReport, CbmAnaJpsiSuperEventReport, CbmAnaJpsiReport, CbmAnaDielectronStudyReportAll, and CbmStsDigitizeQaReport.