cbm::qa::report::HtmlEngine Class Reference

HTML document engine. More...

#include <CbmQaReportHtmlEngine.h>

Inheritance diagram for cbm::qa::report::HtmlEngine:

Collaboration diagram for cbm::qa::report::HtmlEngine:

Public Member Functions
std::string	FigureBody (const Figure &figure) const override
	Creates a body for figure.
std::string	HeaderBody (const Header &header) const override
	Creates a body for header.
std::string	SectionBody (const Section &section) const override
	Creates a body for section.
std::string	TableBody (const Table &table) const override
	Creates a body for table.
std::string	TailBody (const Tail &tail) const override
	Creates a body for tail.
std::string	ScriptExtention () const override
	Returns script extention.
std::string	MyName () const override
	Returns engine name.
virtual void	Compile (const std::string &) const
	Defines the compilation rule (can be omitted)

Static Private Attributes
static constexpr double	kFigureWidth = 0.9
	Figure width [in page width].
static constexpr std::string_view	kTableTextAlign = "left"
	Table: align.
static constexpr int	kTablePadding = 4
	Table: rows padding [px].

Detailed Description

HTML document engine.

Definition at line 21 of file CbmQaReportHtmlEngine.h.

Member Function Documentation

Compile()

virtual void cbm::qa::report::Engine::Compile ( const std::string & ) const

inlinevirtualinherited

Defines the compilation rule (can be omitted)

Parameters

source

Path to the source

Reimplemented in cbm::qa::report::BeamerEngine, and cbm::qa::report::LatexEngine.

Definition at line 66 of file CbmQaReportEngine.h.

Referenced by cbm::qa::report::Builder::CreateScript().

FigureBody()

std::string HtmlEngine::FigureBody ( const Figure & figure ) const

overridevirtual

Creates a body for figure.

Parameters

figure

Reference to figure

Returns

Figure body

Implements cbm::qa::report::Engine.

Definition at line 36 of file CbmQaReportHtmlEngine.cxx.

References cbm::qa::report::Figure::GetCaption(), cbm::qa::report::Element::GetLabel(), cbm::qa::report::Figure::GetPlots(), and kFigureWidth.

HeaderBody()

std::string HtmlEngine::HeaderBody ( const Header & header ) const

overridevirtual

Creates a body for header.

Parameters

header

Reference to header

Returns

Header body

Implements cbm::qa::report::Engine.

Definition at line 53 of file CbmQaReportHtmlEngine.cxx.

References cbm::qa::report::Header::GetAuthor(), cbm::qa::report::Header::GetSetup(), cbm::qa::report::Header::GetSubtitle(), cbm::qa::report::Header::GetTitle(), kTablePadding, and kTableTextAlign.

MyName()

std::string cbm::qa::report::HtmlEngine::MyName ( ) const

inlineoverridevirtual

Returns engine name.

Implements cbm::qa::report::Engine.

Definition at line 52 of file CbmQaReportHtmlEngine.h.

ScriptExtention()

std::string cbm::qa::report::HtmlEngine::ScriptExtention ( ) const

inlineoverridevirtual

Returns script extention.

Implements cbm::qa::report::Engine.

Definition at line 49 of file CbmQaReportHtmlEngine.h.

SectionBody()

std::string HtmlEngine::SectionBody ( const Section & section ) const

overridevirtual

Creates a body for section.

Parameters

section

Reference to section

Returns

Section body

Implements cbm::qa::report::Engine.

Definition at line 99 of file CbmQaReportHtmlEngine.cxx.

References cbm::qa::report::CollapsibleElement::GetDaughterElements(), cbm::qa::report::Section::GetLevel(), and cbm::qa::report::Element::GetTitle().

TableBody()

std::string HtmlEngine::TableBody ( const Table & table ) const

overridevirtual

Creates a body for table.

Parameters

table

Reference to table

Returns

Table body

Implements cbm::qa::report::Engine.

Definition at line 115 of file CbmQaReportHtmlEngine.cxx.

References cbm::qa::report::Table::GetCaption(), cbm::qa::report::Table::GetColumnTitle(), cbm::qa::report::Table::GetNofCols(), and cbm::qa::report::Table::GetNofRows().

TailBody()

std::string HtmlEngine::TailBody ( const Tail & tail ) const

overridevirtual

Creates a body for tail.

Parameters

tail	Reference to tail

Returns

Figure body

Implements cbm::qa::report::Engine.

Definition at line 147 of file CbmQaReportHtmlEngine.cxx.

Member Data Documentation

kFigureWidth

double cbm::qa::report::HtmlEngine::kFigureWidth = 0.9

staticconstexprprivate

Figure width [in page width].

Definition at line 56 of file CbmQaReportHtmlEngine.h.

Referenced by FigureBody().

kTablePadding

int cbm::qa::report::HtmlEngine::kTablePadding = 4

staticconstexprprivate

Table: rows padding [px].

Definition at line 58 of file CbmQaReportHtmlEngine.h.

Referenced by HeaderBody().

kTableTextAlign

std::string_view cbm::qa::report::HtmlEngine::kTableTextAlign = "left"

staticconstexprprivate

Table: align.

Definition at line 57 of file CbmQaReportHtmlEngine.h.

Referenced by HeaderBody().

---

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

• CbmQaReportHtmlEngine.h
• CbmQaReportHtmlEngine.cxx