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

#include <BmnReportElement.h>

Inheritance diagram for BmnReportElement:

Collaboration diagram for BmnReportElement:

Public Member Functions
	BmnReportElement ()
	Constructor.

virtual	~BmnReportElement ()
	Destructor.

virtual string	TableBegin (const string &caption, const vector< string > &colNames) const =0
	Return string with table open tag.

virtual string	TableEnd () const =0
	Return string with table close tag.

virtual string	TableEmptyRow (int nofCols, const string &name) const =0
	Return string with table row which spans over all columns.

virtual string	TableRow (const vector< string > &row) const =0
	Return string with table row tags.

virtual string	Image (const string &title, const string &file) const =0
	Return string with image tags.

virtual string	DocumentBegin () const =0
	Return string with open tags for document.

virtual string	DocumentEnd () const =0
	Return string with close tags of the document.

virtual string	Title (int size, const string &title) const =0
	Return string with title.

	BmnReportElement ()
	Constructor.

virtual	~BmnReportElement ()
	Destructor.

virtual string	TableBegin (const string &caption, const vector< string > &colNames) const =0
	Return string with table open tag.

virtual string	TableEnd () const =0
	Return string with table close tag.

virtual string	TableEmptyRow (int nofCols, const string &name) const =0
	Return string with table row which spans over all columns.

virtual string	TableRow (const vector< string > &row) const =0
	Return string with table row tags.

virtual string	Image (const string &title, const string &file) const =0
	Return string with image tags.

virtual string	DocumentBegin () const =0
	Return string with open tags for document.

virtual string	DocumentEnd () const =0
	Return string with close tags of the document.

virtual string	Title (int size, const string &title) const =0
	Return string with title.

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 BmnReportElement.h.

Constructor & Destructor Documentation

◆ BmnReportElement() [1/2]

BmnReportElement::BmnReportElement ( )

inline

Constructor.

Definition at line 38 of file BmnReportElement.h.

◆ ~BmnReportElement() [1/2]

virtual BmnReportElement::~BmnReportElement ( )

inlinevirtual

Destructor.

Definition at line 43 of file BmnReportElement.h.

◆ BmnReportElement() [2/2]

BmnReportElement::BmnReportElement ( )

inline

Constructor.

Definition at line 38 of file BmnReportElement.h.

◆ ~BmnReportElement() [2/2]

virtual BmnReportElement::~BmnReportElement ( )

inlinevirtual

Destructor.

Definition at line 43 of file BmnReportElement.h.

Member Function Documentation

◆ DocumentBegin() [1/2]

virtual string BmnReportElement::DocumentBegin ( ) const

pure virtual

Return string with open tags for document.

Returns: string with open tags for document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

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

◆ DocumentBegin() [2/2]

virtual string BmnReportElement::DocumentBegin ( ) const

pure virtual

Return string with open tags for document.

Returns: string with open tags for document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ DocumentEnd() [1/2]

virtual string BmnReportElement::DocumentEnd ( ) const

pure virtual

Return string with close tags of the document.

Returns: string with close tags of the document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

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

◆ DocumentEnd() [2/2]

virtual string BmnReportElement::DocumentEnd ( ) const

pure virtual

Return string with close tags of the document.

Returns: string with close tags of the document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ Image() [1/2]

virtual string BmnReportElement::Image	(	const string &	title,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

Referenced by BmnReport::PrintCanvases().

◆ Image() [2/2]

virtual string BmnReportElement::Image	(	const string &	title,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableBegin() [1/2]

virtual string BmnReportElement::TableBegin	(	const string &	caption,
		const vector< 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableBegin() [2/2]

virtual string BmnReportElement::TableBegin	(	const string &	caption,
		const vector< 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEmptyRow() [1/2]

virtual string BmnReportElement::TableEmptyRow	(	int	nofCols,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEmptyRow() [2/2]

virtual string BmnReportElement::TableEmptyRow	(	int	nofCols,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEnd() [1/2]

virtual string BmnReportElement::TableEnd ( ) const

pure virtual

Return string with table close tag.

Returns: String with table close tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEnd() [2/2]

virtual string BmnReportElement::TableEnd ( ) const

pure virtual

Return string with table close tag.

Returns: String with table close tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableRow() [1/2]

virtual string BmnReportElement::TableRow ( const vector< 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableRow() [2/2]

virtual string BmnReportElement::TableRow ( const vector< 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 BmnHtmlReportElement, and BmnHtmlReportElement.

◆ Title() [1/2]

virtual string BmnReportElement::Title	(	int	size,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

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

◆ Title() [2/2]

virtual string BmnReportElement::Title	(	int	size,
		const 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 BmnHtmlReportElement, and BmnHtmlReportElement.

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

install/include/BmnReportElement.h
QA/report/BmnReportElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BmnReportElement() [1/2]

◆ ~BmnReportElement() [1/2]

◆ BmnReportElement() [2/2]

◆ ~BmnReportElement() [2/2]

Member Function Documentation

◆ DocumentBegin() [1/2]

◆ DocumentBegin() [2/2]

◆ DocumentEnd() [1/2]

◆ DocumentEnd() [2/2]

◆ Image() [1/2]

◆ Image() [2/2]

◆ TableBegin() [1/2]

◆ TableBegin() [2/2]

◆ TableEmptyRow() [1/2]

◆ TableEmptyRow() [2/2]

◆ TableEnd() [1/2]

◆ TableEnd() [2/2]

◆ TableRow() [1/2]

◆ TableRow() [2/2]

◆ Title() [1/2]

◆ Title() [2/2]