#include <CbmQaReportSection.h>

Inheritance diagram for cbm::qa::report::Section:

Collaboration diagram for cbm::qa::report::Section:

Public Member Functions
	Section (std::string_view label, std::string_view title)
	Constructor.

	Section ()=default
	Default constructor.

std::string	GetBody (const Engine &engine) const override
	Gets body of the element.

virtual	~Section ()=default
	Destructor.

void	Add (std::shared_ptr< Element > pElement) override
	Adds daughter element.

int	GetLevel () const
	Gets level of the section.

const std::vector< std::shared_ptr< Element > >	GetDaughterElements () const
	Get daughter elements.

	Element (std::string_view label, std::string_view title)
	Constructor.

	Element ()=default
	Default constructor.

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.

Protected Member Functions
void	SetLevel (int level)
	Sets level of the section.

Private Member Functions
void	AssignMother (const Element *pMother)

Private Attributes
int	fLevel = 0
	Level of the section.

std::vector< std::shared_ptr< Element > >	fvDaughterElements
	Daughter elements.

const Element *	fpMother = nullptr
	Mother element.

std::string	fsLabel = ""
	Label for referencing.

std::string	fsTitle = ""
	Title of the element.

Detailed Description

Section of the report.

Definition at line 22 of file CbmQaReportSection.h.

Constructor & Destructor Documentation

◆ Section() [1/2]

Section::Section	(	std::string_view	label,
		std::string_view	title )

Constructor.

Parameters

label	Label of section
title	Title

Definition at line 18 of file CbmQaReportSection.cxx.

◆ Section() [2/2]

cbm::qa::report::Section::Section ( )

default

Default constructor.

◆ ~Section()

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

virtualdefault

Destructor.

Member Function Documentation

◆ Add()

void Section::Add ( std::shared_ptr< Element > pElement )

overridevirtual

Adds daughter element.

Reimplemented from cbm::qa::report::CollapsibleElement.

Definition at line 25 of file CbmQaReportSection.cxx.

References cbm::qa::report::CollapsibleElement::Add(), and fLevel.

◆ AssignMother()

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

inlineprivateinherited

Definition at line 60 of file CbmQaReportElement.h.

References cbm::qa::report::Element::fpMother.

◆ Element() [1/2]

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

defaultinherited

Default constructor.

◆ Element() [2/2]

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

inlineinherited

Constructor.

Parameters

label	Element label
title	Element title

Definition at line 32 of file CbmQaReportElement.h.

◆ GetBody()

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

inlineoverridevirtual

Gets body of the element.

Parameters

engine A concrete implementation of the Engine to get the element body

Implements cbm::qa::report::Element.

Definition at line 34 of file CbmQaReportSection.h.

References cbm::qa::report::Engine::SectionBody().

◆ GetDaughterElements()

const std::vector< std::shared_ptr< Element > > cbm::qa::report::CollapsibleElement::GetDaughterElements ( ) const

inlineinherited

Get daughter elements.

Definition at line 87 of file CbmQaReportElement.h.

References cbm::qa::report::CollapsibleElement::fvDaughterElements.

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

◆ GetLabel()

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

inlineinherited

Gets label.

Definition at line 45 of file CbmQaReportElement.h.

References cbm::qa::report::Element::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().

◆ GetLevel()

int cbm::qa::report::Section::GetLevel ( ) const

inline

Gets level of the section.

Definition at line 43 of file CbmQaReportSection.h.

References fLevel.

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

◆ GetMother()

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

inlineinherited

Gets mother element.

Definition at line 57 of file CbmQaReportElement.h.

References cbm::qa::report::Element::fpMother.

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

◆ GetTitle()

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

inlineinherited

Gets name.

Definition at line 48 of file CbmQaReportElement.h.

References cbm::qa::report::Element::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 )

inlineinherited

Sets label.

Definition at line 51 of file CbmQaReportElement.h.

References cbm::qa::report::Element::fsLabel.

◆ SetLevel()

void cbm::qa::report::Section::SetLevel ( int level )

inlineprotected

Sets level of the section.

Parameters

level Level of the section (is it section, subsection etc.)

Note: The level is assigned in the adding a new section

Definition at line 49 of file CbmQaReportSection.h.

References fLevel.

◆ SetTitle()

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

inlineinherited

Sets name.

Definition at line 54 of file CbmQaReportElement.h.

References cbm::qa::report::Element::fsTitle.

Member Data Documentation

◆ fLevel

int cbm::qa::report::Section::fLevel = 0

private

Level of the section.

Definition at line 52 of file CbmQaReportSection.h.

Referenced by Add(), GetLevel(), and SetLevel().

◆ fpMother

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

privateinherited

Mother element.

Definition at line 63 of file CbmQaReportElement.h.

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

◆ fsLabel

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

privateinherited

Label for referencing.

Definition at line 64 of file CbmQaReportElement.h.

Referenced by cbm::qa::report::Element::GetLabel(), and cbm::qa::report::Element::SetLabel().

◆ fsTitle

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

privateinherited

Title of the element.

Definition at line 65 of file CbmQaReportElement.h.

Referenced by cbm::qa::report::Element::GetTitle(), and cbm::qa::report::Element::SetTitle().

◆ fvDaughterElements

std::vector<std::shared_ptr<Element> > cbm::qa::report::CollapsibleElement::fvDaughterElements

privateinherited

Daughter elements.

Definition at line 90 of file CbmQaReportElement.h.

Referenced by cbm::qa::report::CollapsibleElement::Add(), and cbm::qa::report::CollapsibleElement::GetDaughterElements().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Section() [1/2]

◆ Section() [2/2]

◆ ~Section()

Member Function Documentation

◆ Add()

◆ AssignMother()

◆ Element() [1/2]

◆ Element() [2/2]

◆ GetBody()

◆ GetDaughterElements()

◆ GetLabel()

◆ GetLevel()

◆ GetMother()

◆ GetTitle()

◆ SetLabel()

◆ SetLevel()

◆ SetTitle()

Member Data Documentation

◆ fLevel

◆ fpMother

◆ fsLabel

◆ fsTitle

◆ fvDaughterElements