Base class for reports. More...

#include <CbmReport.h>

Inheritance diagram for CbmReport:

Collaboration diagram for CbmReport:

Public Member Functions
	CbmReport ()
	Constructor.

virtual	~CbmReport ()
	Destructor.

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

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

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	Create ()=0
	Pure abstract function which is called from public Create() function. This function has to write report using Out() for output stream and R() for report elements. This function is called for each report type.

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.

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

void	CreateReports ()
	Create all available report types.

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.

void	SaveCanvasesAsImages () const
	Save all canvases to images.

void	WriteCanvases () const
	Write canvases to file.

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

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

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

	CbmReport (const CbmReport &)

CbmReport &	operator= (const CbmReport &)

Private Attributes
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 reports.

Author: Andrey Lebedev andre.nosp@m.y.le.nosp@m.bedev.nosp@m.@gsi.nosp@m..de

Date: 2011

Definition at line 45 of file CbmReport.h.

Constructor & Destructor Documentation

◆ CbmReport() [1/2]

CbmReport::CbmReport ( )

Constructor.

Definition at line 28 of file CbmReport.cxx.

◆ ~CbmReport()

CbmReport::~CbmReport ( )

virtual

Destructor.

Definition at line 40 of file CbmReport.cxx.

◆ CbmReport() [2/2]

CbmReport::CbmReport ( const CbmReport & )

private

Member Function Documentation

◆ Create()

virtual void CbmReport::Create ( )

protectedpure virtual

Pure abstract function which is called from public Create() function. This function has to write report using Out() for output stream and R() for report elements. This function is called for each report type.

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

Referenced by CreateReports().

◆ CreateCanvas()

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

protected

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 94 of file CbmReport.cxx.

References fCanvases.

◆ CreateReportElement()

void CbmReport::CreateReportElement ( ReportType reportType )

private

Create concrete CbmReportElement instance based on report type.

Parameters

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

Definition at line 42 of file CbmReport.cxx.

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

Referenced by CreateReports().

◆ CreateReports()

void CbmReport::CreateReports ( )

protected

Create all available report types.

Definition at line 71 of file CbmReport.cxx.

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

◆ DeleteReportElement()

void CbmReport::DeleteReportElement ( )

private

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

Definition at line 65 of file CbmReport.cxx.

Referenced by CreateReports().

◆ Draw() [1/2]

virtual void CbmReport::Draw ( )

protectedpure virtual

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 CbmAnaDielectronStudyReportAll, CbmAnaJpsiReport, CbmAnaJpsiSuperEventReport, CbmLitClusteringQaReport, CbmLitClusteringQaStudyReport, CbmLitFieldApproximationQaReport, CbmLitFieldQaReport, CbmLitFitQaReport, CbmLitFitQaStudyReport, CbmLitRadLengthQaReport, CbmLitTofQaReport, CbmLitTrackingQaReport, CbmLitTrackingQaStudyReport, CbmRichGeoTestStudyReport, and CbmStsDigitizeQaReport.