CbmReportElement Class Reference

Abstract class for basic report elements (headers, tables, images etc.). More...

#include <CbmReportElement.h>

Inheritance diagram for CbmReportElement:

Collaboration diagram for CbmReportElement:

Public Member Functions
	CbmReportElement ()
	Constructor. More...
virtual	~CbmReportElement ()
	Destructor. More...
virtual std::string	TableBegin (const std::string &caption, const std::vector< std::string > &colNames) const =0
	Return string with table open tag. More...
virtual std::string	TableEnd () const =0
	Return string with table close tag. More...
virtual std::string	TableEmptyRow (int nofCols, const std::string &name) const =0
	Return string with table row which spans over all columns. More...
virtual std::string	TableRow (const std::vector< std::string > &row) const =0
	Return string with table row tags. More...
virtual std::string	Image (const std::string &title, const std::string &file) const =0
	Return string with image tags. More...
virtual std::string	DocumentBegin () const =0
	Return string with open tags for document. More...
virtual std::string	DocumentEnd () const =0
	Return string with close tags of the document. More...
virtual std::string	Title (int size, const std::string &title) const =0
	Return string with title. More...

Detailed Description

Abstract class for basic report elements (headers, tables, images etc.).

Each concrete implementation for report elements has to implement this interface (e.g. Latex, text, HTML). Report has to be written using functionality of this interface class in order to be able to automatically produce reports in different representations (e.g. Latex, text, HTML).

Author

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

Date

2011

Definition at line 32 of file CbmReportElement.h.

Constructor & Destructor Documentation

CbmReportElement()

CbmReportElement::CbmReportElement ( )

inline

Constructor.

Definition at line 37 of file CbmReportElement.h.

~CbmReportElement()

virtual CbmReportElement::~CbmReportElement ( )

inlinevirtual

Destructor.

Definition at line 42 of file CbmReportElement.h.

Member Function Documentation

DocumentBegin()

virtual std::string CbmReportElement::DocumentBegin ( ) const

pure virtual

Return string with open tags for document.

Returns

string with open tags for document.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmStsDigitizeQaReport::Create(), CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitTofQaReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitClusteringQaStudyReport::Create(), CbmLitFitQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitClusteringQaReport::Create(), CbmRichGeoTestStudyReport::Create(), and CbmLitTrackingQaStudyReport::Create().

DocumentEnd()

virtual std::string CbmReportElement::DocumentEnd ( ) const

pure virtual

Return string with close tags of the document.

Returns

string with close tags of the document.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmStsDigitizeQaReport::Create(), CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitTofQaReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitClusteringQaStudyReport::Create(), CbmLitFitQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitClusteringQaReport::Create(), CbmRichGeoTestStudyReport::Create(), and CbmLitTrackingQaStudyReport::Create().

Image()

virtual std::string CbmReportElement::Image ( const std::string &  title, const std::string &  file  ) const

pure virtual

Return string with image tags.

Parameters

[in]	title	Title of the image.
[in]	file	Name of the image file.

Returns

string with image tags.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmReport::PrintCanvases().

TableBegin()

virtual std::string CbmReportElement::TableBegin ( const std::string &  caption, const std::vector< std::string > &  colNames  ) const

pure virtual

Return string with table open tag.

Parameters

[in]	caption	Table caption.
[in]	colNames	Names of the columns in table.

Returns

String with table open tag.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmLitFitQaReport::Create(), CbmRichGeoTestStudyReport::Create(), CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitTrackingQaReport::PrintNofGhosts(), CbmLitClusteringQaStudyReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintNofObjects(), CbmLitClusteringQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintPionSuppression(), CbmLitTrackingQaStudyReport::PrintTable(), CbmLitTrackingQaReport::PrintTrackHits(), and CbmLitTrackingQaReport::PrintTrackingEfficiency().

TableEmptyRow()

virtual std::string CbmReportElement::TableEmptyRow ( int  nofCols, const std::string &  name  ) const

pure virtual

Return string with table row which spans over all columns.

Parameters

[in]	nofCols	number of columns in table.
[in]	name	Name of the row.

Returns

string with table row which spans over all columns.

Implemented in CbmHtmlReportElement, and CbmLatexReportElement.

TableEnd()

virtual std::string CbmReportElement::TableEnd ( ) const

pure virtual

Return string with table close tag.

Returns

String with table close tag.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmLitFitQaReport::Create(), CbmRichGeoTestStudyReport::Create(), CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitTrackingQaReport::PrintNofGhosts(), CbmLitClusteringQaStudyReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintNofObjects(), CbmLitClusteringQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintPionSuppression(), CbmLitTrackingQaStudyReport::PrintTable(), CbmLitTrackingQaReport::PrintTrackHits(), and CbmLitTrackingQaReport::PrintTrackingEfficiency().

TableRow()

virtual std::string CbmReportElement::TableRow ( const std::vector< std::string > &  row ) const

pure virtual

Return string with table row tags.

Parameters

[in]

data

Array of strings with data for each cell in a row.

Returns

string with table row tags.

Implemented in CbmTextReportElement, CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitTrackingQaReport::PrintNofGhosts(), CbmLitClusteringQaStudyReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintNofObjects(), CbmLitClusteringQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintPionSuppression(), CbmLitFitQaReport::PrintResAndPullRow(), CbmRichGeoTestStudyReport::PrintRow(), CbmLitTrackingQaStudyReport::PrintTable(), CbmLitTrackingQaReport::PrintTrackHits(), and CbmLitTrackingQaReport::PrintTrackingEfficiency().

Title()

virtual std::string CbmReportElement::Title ( int  size, const std::string &  title  ) const

pure virtual

Return string with title.

Parameters

[in]	size	Size of the title. [0-5]. 0 is the largest size.
[in]	title	Title string.

Returns

string with subtitle.

Implemented in CbmHtmlReportElement, and CbmLatexReportElement.

Referenced by CbmStsDigitizeQaReport::Create(), CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitTofQaReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitClusteringQaStudyReport::Create(), CbmLitFitQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitClusteringQaReport::Create(), CbmRichGeoTestStudyReport::Create(), and CbmLitTrackingQaStudyReport::Create().

---

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

• CbmReportElement.h