cbm::qa::report::CollapsibleElement Class Reference

Interface to the element, which can contain daughter elements. More...

#include <CbmQaReportElement.h>

Inheritance diagram for cbm::qa::report::CollapsibleElement:

Collaboration diagram for cbm::qa::report::CollapsibleElement:

Public Member Functions
virtual	~CollapsibleElement ()=default
	Destructor.
virtual void	Add (std::shared_ptr< Element > pElement)
	Adds element.
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.
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
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

Interface to the element, which can contain daughter elements.

Definition at line 71 of file CbmQaReportElement.h.

Constructor & Destructor Documentation

~CollapsibleElement()

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

virtualdefault

Destructor.

Member Function Documentation

Add()

virtual void cbm::qa::report::CollapsibleElement::Add ( std::shared_ptr< Element > pElement )

inlinevirtual

Adds element.

Reimplemented in cbm::qa::report::Section.

Definition at line 80 of file CbmQaReportElement.h.

References fvDaughterElements.

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

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

default

Default constructor.

Element() [2/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.

GetBody()

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

pure virtualinherited

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.

GetDaughterElements()

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

inline

Get daughter elements.

Definition at line 87 of file CbmQaReportElement.h.

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

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.

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

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

private

Daughter elements.

Definition at line 90 of file CbmQaReportElement.h.

Referenced by Add(), and GetDaughterElements().

---

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

• CbmQaReportElement.h