BmnRoot
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BmnReport Class Referenceabstract

Base class for reports. More...

#include <BmnReport.h>

Inheritance diagram for BmnReport:
[legend]
Collaboration diagram for BmnReport:
[legend]

Public Member Functions

 BmnReport ()
 Constructor.
 
virtual ~BmnReport ()
 Destructor.
 
const BmnReportElement * R () const
 Accessor to BmnReportElement object. User has to write the report using available tags from BmnReportElement class.
 
ostream & Out () const
 All text output goes to this stream.
 
void Register (string path)
 
void CallDraw ()
 
void SetReportName (TString name)
 
void SetReportTitle (const string &title)
 
void SetOutputDir (const string &outputDir)
 
void SetMonitorMode (const Bool_t mm)
 
void SetObjServer (THttpServer *s)
 
const string & GetReportName () const
 
const string & GetReportTitle () const
 
const string & GetOutputDir () const
 
Bool_t GetMonitorMode () const
 
THttpServer * GetObjServer () const
 
 BmnReport ()
 Constructor.
 
virtual ~BmnReport ()
 Destructor.
 
const BmnReportElement * R () const
 Accessor to BmnReportElement object. User has to write the report using available tags from BmnReportElement class.
 
ostream & Out () const
 All text output goes to this stream.
 
void Register (string path)
 
void CallDraw ()
 
void SetReportName (TString name)
 
void SetReportTitle (const string &title)
 
void SetOutputDir (const string &outputDir)
 
void SetMonitorMode (const Bool_t mm)
 
void SetObjServer (THttpServer *s)
 
const string & GetReportName () const
 
const string & GetReportTitle () const
 
const string & GetOutputDir () const
 
Bool_t GetMonitorMode () const
 
THttpServer * GetObjServer () 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.
 
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.
 

Protected Attributes

THttpServer * fServer
 
Bool_t fMonitorMode
 
Bool_t fInitCanvasesDone
 

Detailed Description

Base class for reports.

Author
Andrey Lebedev andre.nosp@m.y.le.nosp@m.bedev.nosp@m.@gsi.nosp@m..de
Ilnur Gabdrakhmanov ilnur.nosp@m.@jin.nosp@m.r.ru - unificiation for online/offline mode
Date
2011 - 2025

Definition at line 28 of file BmnReport.h.

Constructor & Destructor Documentation

◆ BmnReport() [1/2]

BmnReport::BmnReport ( )

Constructor.

Definition at line 17 of file BmnReport.cxx.

◆ ~BmnReport() [1/2]

BmnReport::~BmnReport ( )
virtual

Destructor.

Definition at line 28 of file BmnReport.cxx.

◆ BmnReport() [2/2]

BmnReport::BmnReport ( )

Constructor.

◆ ~BmnReport() [2/2]

virtual BmnReport::~BmnReport ( )
virtual

Destructor.

Member Function Documentation

◆ CallDraw() [1/2]

void BmnReport::CallDraw ( )
inline

Definition at line 53 of file BmnReport.h.

References Draw().

Referenced by BmnProfQa::Exec(), BmnQaBase::Exec(), BmnTrackingQaExp::Exec(), BmnProfQa::Finish(), BmnTrackingQaExp::Finish(), BmnProfQa::Init(), BmnQaBase::Init(), and BmnTrackingQaExp::Init().

◆ CallDraw() [2/2]

void BmnReport::CallDraw ( )
inline

Definition at line 53 of file BmnReport.h.

References Draw().

◆ Create() [1/2]

virtual void BmnReport::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 BmnPidQaReport, BmnProfQaReport, BmnSimulationReport, BmnTrackingQaReport, BmnPidQaReport, BmnProfQaReport, BmnTrackingQaReport, and BmnSimulationReport.

Referenced by CreateReports().

◆ Create() [2/2]

virtual void BmnReport::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 BmnPidQaReport, BmnProfQaReport, BmnSimulationReport, BmnTrackingQaReport, BmnPidQaReport, BmnProfQaReport, BmnTrackingQaReport, and BmnSimulationReport.

◆ CreateCanvas() [1/2]

TCanvas * BmnReport::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.

Create or just find already created.

Parameters
name
title
ww
wh
Returns

Definition at line 75 of file BmnReport.cxx.

Referenced by BmnPidQaReport::DrawEffCont(), BmnTrackingQaReport::DrawEffGem(), BmnTrackingQaReport::DrawEventsInfo(), BmnSimulationReport::DrawFourH2(), BmnTrackingQaReport::DrawMomResGem(), BmnSimulationReport::DrawNH2(), BmnTrackingQaReport::DrawNhitsGem(), BmnPidQaReport::DrawOneH1(), BmnTrackingQaReport::DrawOneH1(), BmnSimulationReport::DrawOneH1(), BmnPidQaReport::DrawOneH2(), BmnTrackingQaReport::DrawOneH2(), BmnSimulationReport::DrawOneH2(), BmnTrackingQaReport::DrawPar(), BmnTrackingQaReport::DrawResAndPull(), BmnPidQaReport::DrawThreeH1(), BmnTrackingQaReport::DrawThreeH1(), BmnSimulationReport::DrawThreeH1(), BmnPidQaReport::DrawThreeH2(), BmnTrackingQaReport::DrawThreeH2(), BmnSimulationReport::DrawThreeH2(), BmnPidQaReport::DrawTwoBananas(), BmnPidQaReport::DrawTwoH1(), BmnTrackingQaReport::DrawTwoH1(), BmnSimulationReport::DrawTwoH1(), BmnPidQaReport::DrawTwoH2(), BmnSimulationReport::DrawTwoH2(), BmnTrackingQaReport::DrawTwoH2(), and BmnTrackingQaReport::DrawVertResGem().

◆ CreateCanvas() [2/2]

TCanvas * BmnReport::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.

◆ CreateReports() [1/2]

void BmnReport::CreateReports ( )
protected

Create all available report types.

Definition at line 54 of file BmnReport.cxx.

References Create(), Draw(), fMonitorMode, SaveCanvasesAsImages(), and WriteCanvases().

Referenced by BmnSimulationReport::Create(), and BmnSimulationReport::Create().

◆ CreateReports() [2/2]

void BmnReport::CreateReports ( )
protected

Create all available report types.

◆ Draw() [1/2]

virtual void BmnReport::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 BmnPidQaReport, BmnProfQaReport, BmnTrackingQaExpReport, BmnTrackingQaReport, BmnPidQaReport, BmnProfQaReport, BmnTrackingQaExpReport, and BmnTrackingQaReport.

Referenced by CallDraw(), and CreateReports().

◆ Draw() [2/2]

virtual void BmnReport::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 BmnPidQaReport, BmnProfQaReport, BmnTrackingQaExpReport, BmnTrackingQaReport, BmnPidQaReport, BmnProfQaReport, BmnTrackingQaExpReport, and BmnTrackingQaReport.

◆ GetMonitorMode() [1/2]

Bool_t BmnReport::GetMonitorMode ( ) const
inline

Definition at line 76 of file BmnReport.h.

References fMonitorMode.

◆ GetMonitorMode() [2/2]

Bool_t BmnReport::GetMonitorMode ( ) const
inline

Definition at line 76 of file BmnReport.h.

References fMonitorMode.

◆ GetObjServer() [1/2]

THttpServer * BmnReport::GetObjServer ( ) const
inline

Definition at line 77 of file BmnReport.h.

References fServer.

◆ GetObjServer() [2/2]

THttpServer * BmnReport::GetObjServer ( ) const
inline

Definition at line 77 of file BmnReport.h.

References fServer.

◆ GetOutputDir() [1/2]

const string & BmnReport::GetOutputDir ( ) const
inline

Definition at line 75 of file BmnReport.h.

Referenced by SaveCanvasesAsImages(), and WriteCanvases().

◆ GetOutputDir() [2/2]

const string & BmnReport::GetOutputDir ( ) const
inline

Definition at line 75 of file BmnReport.h.

◆ GetReportName() [1/2]

const string & BmnReport::GetReportName ( ) const
inline

Definition at line 73 of file BmnReport.h.

◆ GetReportName() [2/2]

const string & BmnReport::GetReportName ( ) const
inline

Definition at line 73 of file BmnReport.h.

◆ GetReportTitle() [1/2]

const string & BmnReport::GetReportTitle ( ) const
inline

Definition at line 74 of file BmnReport.h.

◆ GetReportTitle() [2/2]

const string & BmnReport::GetReportTitle ( ) const
inline

Definition at line 74 of file BmnReport.h.

◆ Out() [1/2]

ostream & BmnReport::Out ( ) const
inline

All text output goes to this stream.

Definition at line 50 of file BmnReport.h.

Referenced by BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), BmnTrackingQaReport::Create(), PrintCanvases(), and BmnTrackingQaReport::PrintEventInfo().

◆ Out() [2/2]

ostream & BmnReport::Out ( ) const
inline

All text output goes to this stream.

Definition at line 50 of file BmnReport.h.

◆ PrintCanvases() [1/2]

void BmnReport::PrintCanvases ( ) const
protected

Print images created from canvases in the report.

Definition at line 113 of file BmnReport.cxx.

References i, BmnReportElement::Image(), Out(), and R().

Referenced by BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), and BmnTrackingQaReport::Create().

◆ PrintCanvases() [2/2]

void BmnReport::PrintCanvases ( ) const
protected

Print images created from canvases in the report.

◆ R() [1/2]

const BmnReportElement * BmnReport::R ( ) const
inline

Accessor to BmnReportElement object. User has to write the report using available tags from BmnReportElement class.

Definition at line 45 of file BmnReport.h.

Referenced by BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), BmnTrackingQaReport::Create(), and PrintCanvases().

◆ R() [2/2]

const BmnReportElement * BmnReport::R ( ) const
inline

Accessor to BmnReportElement object. User has to write the report using available tags from BmnReportElement class.

Definition at line 45 of file BmnReport.h.

◆ Register() [1/2]

void BmnReport::Register ( string  path)

Definition at line 122 of file BmnReport.cxx.

References can(), and fServer.

Referenced by BmnProfQa::Init(), BmnQaBase::Init(), and BmnTrackingQaExp::Init().

◆ Register() [2/2]

void BmnReport::Register ( string  path)

◆ SaveCanvasesAsImages() [1/2]

void BmnReport::SaveCanvasesAsImages ( ) const
protected

Save all canvases to images.

Definition at line 89 of file BmnReport.cxx.

References GetOutputDir(), and i.

Referenced by CreateReports().

◆ SaveCanvasesAsImages() [2/2]

void BmnReport::SaveCanvasesAsImages ( ) const
protected

Save all canvases to images.

◆ SetMonitorMode() [1/2]

void BmnReport::SetMonitorMode ( const Bool_t  mm)
inline

Definition at line 69 of file BmnReport.h.

References fMonitorMode.

Referenced by BmnProfQa::Init(), BmnQaBase::Init(), and BmnTrackingQaExp::Init().

◆ SetMonitorMode() [2/2]

void BmnReport::SetMonitorMode ( const Bool_t  mm)
inline

Definition at line 69 of file BmnReport.h.

References fMonitorMode.

◆ SetObjServer() [1/2]

void BmnReport::SetObjServer ( THttpServer *  s)
inline

Definition at line 70 of file BmnReport.h.

References fServer.

Referenced by BmnProfQa::Init(), BmnQaBase::Init(), and BmnTrackingQaExp::Init().

◆ SetObjServer() [2/2]

void BmnReport::SetObjServer ( THttpServer *  s)
inline

Definition at line 70 of file BmnReport.h.

References fServer.

◆ SetOutputDir() [1/2]

void BmnReport::SetOutputDir ( const string &  outputDir)
inline

Definition at line 58 of file BmnReport.h.

Referenced by BmnSimulationReport::Create(), and BmnSimulationReport::Create().

◆ SetOutputDir() [2/2]

void BmnReport::SetOutputDir ( const string &  outputDir)
inline

Definition at line 58 of file BmnReport.h.

◆ SetReportName() [1/2]

void BmnReport::SetReportName ( TString  name)
inline

Definition at line 56 of file BmnReport.h.

Referenced by BmnClusteringQaReport::BmnClusteringQaReport(), BmnLambdaQaReport::BmnLambdaQaReport(), BmnPidQaReport::BmnPidQaReport(), BmnPidQaReport::BmnPidQaReport(), BmnProfQaReport::BmnProfQaReport(), BmnProfQaReport::BmnProfQaReport(), BmnTrackingQaExpReport::BmnTrackingQaExpReport(), BmnTrackingQaExpReport::BmnTrackingQaExpReport(), BmnTrackingQaReport::BmnTrackingQaReport(), and BmnTrackingQaReport::BmnTrackingQaReport().

◆ SetReportName() [2/2]

void BmnReport::SetReportName ( TString  name)
inline

Definition at line 56 of file BmnReport.h.

◆ SetReportTitle() [1/2]

void BmnReport::SetReportTitle ( const string &  title)
inline

Definition at line 57 of file BmnReport.h.

◆ SetReportTitle() [2/2]

void BmnReport::SetReportTitle ( const string &  title)
inline

Definition at line 57 of file BmnReport.h.

◆ WriteCanvases() [1/2]

void BmnReport::WriteCanvases ( ) const
protected

Write canvases to file.

Definition at line 103 of file BmnReport.cxx.

References GetOutputDir(), and i.

Referenced by CreateReports().

◆ WriteCanvases() [2/2]

void BmnReport::WriteCanvases ( ) const
protected

Write canvases to file.

Member Data Documentation

◆ fInitCanvasesDone

Bool_t BmnReport::fInitCanvasesDone
protected

Definition at line 123 of file BmnReport.h.

Referenced by BmnProfQaReport::Draw(), BmnTrackingQaExpReport::Draw(), BmnSimulationReport::DrawFourH2(), BmnSimulationReport::DrawNH2(), BmnSimulationReport::DrawOneH1(), BmnSimulationReport::DrawOneH2(), BmnSimulationReport::DrawThreeH1(), BmnSimulationReport::DrawThreeH2(), BmnSimulationReport::DrawTwoH1(), and BmnSimulationReport::DrawTwoH2().

◆ fMonitorMode

Bool_t BmnReport::fMonitorMode
protected

Definition at line 122 of file BmnReport.h.

Referenced by CreateReports(), GetMonitorMode(), and SetMonitorMode().

◆ fServer

THttpServer * BmnReport::fServer
protected

Definition at line 121 of file BmnReport.h.

Referenced by GetObjServer(), Register(), and SetObjServer().

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