cbm::qa::report::Element Class Reference

Interface for the report element. More...

#include <CbmQaReportElement.h>

Inheritance diagram for cbm::qa::report::Element:

Collaboration diagram for cbm::qa::report::Element:

Public Member Functions
	Element (std::string_view label, std::string_view title)
	Constructor.
	Element ()=default
	Default constructor.
virtual	~Element ()=default
	Destructor.
virtual std::string	GetBody (const Engine &engine) const =0
	Gets body of the element.
const std::string &	GetLabel () const
	Gets label.
const std::string &	GetTitle () const
	Gets name.
void	SetLabel (std::string_view label)
	Sets label.
void	SetTitle (std::string_view title)
	Sets name.
const Element *	GetMother () const
	Gets mother element.

Private Member Functions
void	AssignMother (const Element *pMother)

Private Attributes
const Element *	fpMother = nullptr
	Mother element.
std::string	fsLabel = ""
	Label for referencing.
std::string	fsTitle = ""
	Title of the element.

Friends
class	CollapsibleElement

Detailed Description

Interface for the report element.

Definition at line 25 of file CbmQaReportElement.h.

Constructor & Destructor Documentation

Element() [1/2]

cbm::qa::report::Element::Element ( std::string_view label, std::string_view title )

inline

Constructor.

Parameters

label	Element label
title	Element title

Definition at line 32 of file CbmQaReportElement.h.

References fsLabel, and fsTitle.

Referenced by AssignMother(), cbm::qa::report::Figure::Figure(), GetMother(), and cbm::qa::report::Table::Table().

Element() [2/2]

cbm::qa::report::Element::Element ( )

default

Default constructor.

~Element()

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

virtualdefault

Destructor.

Member Function Documentation

AssignMother()

void cbm::qa::report::Element::AssignMother ( const Element * pMother )

inlineprivate

Definition at line 60 of file CbmQaReportElement.h.

References Element(), and fpMother.

GetBody()

virtual std::string cbm::qa::report::Element::GetBody ( const Engine & engine ) const

pure virtual

Gets body of the element.

Parameters

engine

A concrete implementation of the Engine to get the element body

Implemented in cbm::qa::report::Figure, cbm::qa::report::Section, and cbm::qa::report::Table.

GetLabel()

const std::string & cbm::qa::report::Element::GetLabel ( ) const

inline

Gets label.

Definition at line 45 of file CbmQaReportElement.h.

References fsLabel.

Referenced by cbm::qa::report::BeamerEngine::FigureBody(), cbm::qa::report::HtmlEngine::FigureBody(), cbm::qa::report::LatexEngine::FigureBody(), cbm::qa::report::Table::Set(), cbm::qa::report::BeamerEngine::TableBody(), and cbm::qa::report::LatexEngine::TableBody().

GetMother()

const Element * cbm::qa::report::Element::GetMother ( ) const

inline

Gets mother element.

Definition at line 57 of file CbmQaReportElement.h.

References Element(), and fpMother.

Referenced by cbm::qa::report::BeamerEngine::FigureBody(), and cbm::qa::report::BeamerEngine::TableBody().

GetTitle()

const std::string & cbm::qa::report::Element::GetTitle ( ) const

inline

Gets name.

Definition at line 48 of file CbmQaReportElement.h.

References fsTitle.

Referenced by cbm::qa::report::BeamerEngine::FigureBody(), cbm::qa::report::BeamerEngine::SectionBody(), cbm::qa::report::HtmlEngine::SectionBody(), cbm::qa::report::LatexEngine::SectionBody(), and cbm::qa::report::BeamerEngine::TableBody().

SetLabel()

void cbm::qa::report::Element::SetLabel ( std::string_view label )

inline

Sets label.

Definition at line 51 of file CbmQaReportElement.h.

References fsLabel.

SetTitle()

void cbm::qa::report::Element::SetTitle ( std::string_view title )

inline

Sets name.

Definition at line 54 of file CbmQaReportElement.h.

References fsTitle.

Friends And Related Symbol Documentation

CollapsibleElement

friend class CollapsibleElement

friend

Definition at line 26 of file CbmQaReportElement.h.

References CollapsibleElement.

Referenced by CollapsibleElement.

Member Data Documentation

fpMother

const Element* cbm::qa::report::Element::fpMother = nullptr

private

Mother element.

Definition at line 63 of file CbmQaReportElement.h.

Referenced by AssignMother(), and GetMother().

fsLabel

std::string cbm::qa::report::Element::fsLabel = ""

private

Label for referencing.

Definition at line 64 of file CbmQaReportElement.h.

Referenced by Element(), GetLabel(), and SetLabel().

fsTitle

std::string cbm::qa::report::Element::fsTitle = ""

private

Title of the element.

Definition at line 65 of file CbmQaReportElement.h.

Referenced by Element(), GetTitle(), and SetTitle().

---

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

• CbmQaReportElement.h