cbm::qa::report::LatexEngine Class Reference

Plain LaTeX document engine. More...

#include <CbmQaReportLatexEngine.h>

Inheritance diagram for cbm::qa::report::LatexEngine:

Collaboration diagram for cbm::qa::report::LatexEngine:

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.
void	Compile (const std::string &source) const override
	Compiles source.
void	SetLatexCompiler (std::string_view latexCompiler)
	Sets the LaTeX compilation program name.

Private Attributes
std::string	fsLatexCompiler = "pdflatex -interaction=nonstopmode"

Static Private Attributes
static constexpr double	kFigureWidth = 1.0
	Figure width [in textwidth].

Detailed Description

Plain LaTeX document engine.

Definition at line 21 of file CbmQaReportLatexEngine.h.

Member Function Documentation

Compile()

void LatexEngine::Compile ( const std::string & source ) const

overridevirtual

Compiles source.

Parameters

source

Source path

Reimplemented from cbm::qa::report::Engine.

Definition at line 257 of file CbmQaReportLatexEngine.cxx.

References fsLatexCompiler.

FigureBody()

std::string LatexEngine::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 38 of file CbmQaReportLatexEngine.cxx.

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

HeaderBody()

std::string LatexEngine::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 125 of file CbmQaReportLatexEngine.cxx.

References cbm::qa::report::LatexFormat::Apply(), cbm::qa::report::Header::GetAuthor(), cbm::qa::report::Header::GetPageHeader(), cbm::qa::report::Header::GetSetup(), cbm::qa::report::Header::GetSubtitle(), and cbm::qa::report::Header::GetTitle().

MyName()

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

inlineoverridevirtual

Returns engine name.

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

Definition at line 52 of file CbmQaReportLatexEngine.h.

ScriptExtention()

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

inlineoverridevirtual

Returns script extention.

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

Definition at line 49 of file CbmQaReportLatexEngine.h.

SectionBody()

std::string LatexEngine::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 181 of file CbmQaReportLatexEngine.cxx.

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

SetLatexCompiler()

void cbm::qa::report::LatexEngine::SetLatexCompiler ( std::string_view latexCompiler )

inline

Sets the LaTeX compilation program name.

Parameters

latexCompiler

A LaTeX compiler

Note

The compiler can contain options

Definition at line 61 of file CbmQaReportLatexEngine.h.

References fsLatexCompiler.

TableBody()

std::string LatexEngine::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 209 of file CbmQaReportLatexEngine.cxx.

References cbm::qa::report::LatexFormat::Apply(), cbm::qa::report::Table::GetCaption(), cbm::qa::report::Table::GetColumnTitle(), cbm::qa::report::Element::GetLabel(), cbm::qa::report::Table::GetNofCols(), and cbm::qa::report::Table::GetNofRows().

TailBody()

std::string LatexEngine::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 248 of file CbmQaReportLatexEngine.cxx.

Member Data Documentation

fsLatexCompiler

std::string cbm::qa::report::LatexEngine::fsLatexCompiler = "pdflatex -interaction=nonstopmode"

private

Definition at line 66 of file CbmQaReportLatexEngine.h.

Referenced by Compile(), and SetLatexCompiler().

kFigureWidth

double cbm::qa::report::LatexEngine::kFigureWidth = 1.0

staticconstexprprivate

Figure width [in textwidth].

Definition at line 64 of file CbmQaReportLatexEngine.h.

Referenced by FigureBody().

---

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

• CbmQaReportLatexEngine.h
• CbmQaReportLatexEngine.cxx