Base class for reports. More...

#include <EicRoot/blob/master/cbmbase/report/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.

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

void	SetReportName (const string &name)

void	SetReportTitle (const string &title)

void	SetOutputDir (const string &outputDir)

const string &	GetReportName () const

const string &	GetReportTitle () const

const 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	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
string	fReportName

string	fReportTitle

string	fOutputDir

ReportType	fReportType

CbmReportElement *	fR

ostream *	fOut

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 35 of file CbmReport.h.

View newest version in sPHENIX GitHub at line 35 of file CbmReport.h

Constructor & Destructor Documentation

CbmReport::CbmReport ( )

Constructor.

Definition at line 18 of file CbmReport.cxx.

View newest version in sPHENIX GitHub at line 18 of file CbmReport.cxx

CbmReport::~CbmReport ( )

virtual

Destructor.

Definition at line 29 of file CbmReport.cxx.

View newest version in sPHENIX GitHub at line 29 of file CbmReport.cxx

CbmReport::CbmReport ( const CbmReport & )

private

Member Function Documentation

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 CbmRichGeoTestStudyReport.

Referenced by CreateReports().

Here is the caller graph for this function:

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

View newest version in sPHENIX GitHub at line 83 of file CbmReport.cxx

References fCanvases.

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

View newest version in sPHENIX GitHub at line 33 of file CbmReport.cxx

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

Referenced by CreateReports().

Here is the call graph for this function:

Here is the caller graph for this function:

void CbmReport::CreateReports ( )

protected

Create all available report types.

Definition at line 60 of file CbmReport.cxx.

View newest version in sPHENIX GitHub at line 60 of file CbmReport.cxx

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

Referenced by CbmStudyReport::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

void CbmReport::DeleteReportElement ( )

private

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

Definition at line 54 of file CbmReport.cxx.

View newest version in sPHENIX GitHub at line 54 of file CbmReport.cxx

Referenced by CreateReports().

Here is the caller graph for this function:

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 CbmRichGeoTestStudyReport.

Referenced by CreateReports().

Here is the caller graph for this function:

const string& CbmReport::GetOutputDir ( ) const

inline

Definition at line 66 of file CbmReport.h.

View newest version in sPHENIX GitHub at line 66 of file CbmReport.h

References fOutputDir.

Referenced by CreateReportElement(), SaveCanvasesAsImages(), and WriteCanvases().

Here is the caller graph for this function:

const string& CbmReport::GetReportName ( ) const

inline