cbm::qa::report::Engine Class Reference

A base abstract class to provide an interface for element body (a visitor in the Visitor pattern) More...

#include <CbmQaReportEngine.h>

Inheritance diagram for cbm::qa::report::Engine:

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

Detailed Description

A base abstract class to provide an interface for element body (a visitor in the Visitor pattern)

Each method of the class provides interface to create the body of the document element. The body is returned as a string.

Definition at line 28 of file CbmQaReportEngine.h.

Constructor & Destructor Documentation

~Engine()

virtual cbm::qa::report::Engine::~Engine ( )

virtualdefault

Destructor.

Member Function Documentation

Compile()

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

inlinevirtual

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()

virtual std::string cbm::qa::report::Engine::FigureBody ( const Figure & figure ) const

pure virtual

Creates a body for figure.

Parameters

figure

Reference to figure

Returns

Figure body

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

Referenced by cbm::qa::report::Figure::GetBody().

HeaderBody()

virtual std::string cbm::qa::report::Engine::HeaderBody ( const Header & header ) const

pure virtual

Creates a body for header.

Parameters

header

Reference to header

Returns

Header body

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

Referenced by cbm::qa::report::Header::GetBody().

MyName()

virtual std::string cbm::qa::report::Engine::MyName ( ) const

pure virtual

Returns engine name.

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

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

ScriptExtention()

virtual std::string cbm::qa::report::Engine::ScriptExtention ( ) const

pure virtual

Returns script extention.

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

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

SectionBody()

virtual std::string cbm::qa::report::Engine::SectionBody ( const Section & section ) const

pure virtual

Creates a body for section.

Parameters

section

Reference to section

Returns

Section body

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

Referenced by cbm::qa::report::Section::GetBody().

TableBody()

virtual std::string cbm::qa::report::Engine::TableBody ( const Table & table ) const

pure virtual

Creates a body for table.

Parameters

table

Reference to table

Returns

Table body

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

Referenced by cbm::qa::report::Table::GetBody().

TailBody()

virtual std::string cbm::qa::report::Engine::TailBody ( const Tail & tail ) const

pure virtual

Creates a body for tail.

Parameters

tail	Reference to tail

Returns

Figure body

Implemented in cbm::qa::report::BeamerEngine, cbm::qa::report::HtmlEngine, and cbm::qa::report::LatexEngine.

Referenced by cbm::qa::report::Tail::GetBody().

---

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

• CbmQaReportEngine.h