cbm::qa::report::Header Class Reference

Header of the report. More...

#include <CbmQaReportHeader.h>

Collaboration diagram for cbm::qa::report::Header:

Public Member Functions
virtual	~Header ()=default
	Destructor.
void	AddTag (std::string_view tag)
	Add tag.
std::string	GetBody (const Engine &engine) const
	Gets body of the element.
const std::string &	GetAuthor () const
	Gets author.
const std::string &	GetPageHeader () const
	Gets page header.
const std::string &	GetSetup () const
	Gets setup.
const std::string &	GetSubtitle () const
	Gets subtitle.
const std::vector< std::string > &	GetTags () const
	Gets tags.
const std::string &	GetTitle () const
	Gets title.
void	SetAuthor (std::string_view author)
	Sets author.
void	SetPageHeader (std::string_view pageHeader)
	Sets page header.
void	SetSetup (std::string_view setup)
	Sets setup.
void	SetSubtitle (std::string_view subtitle)
	Sets subtitle.
void	SetTitle (std::string_view title)
	Sets title.

Private Attributes
std::vector< std::string >	fvsTags {}
	Different Tags.
std::string	fsAuthor = ""
std::string	fsSetup = ""
std::string	fsSubtitle = ""
std::string	fsTitle = ""
std::string	fsPageHeader = ""
	Placed on top/bottom of the page.

Detailed Description

Header of the report.

Definition at line 21 of file CbmQaReportHeader.h.

Constructor & Destructor Documentation

~Header()

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

virtualdefault

Destructor.

Member Function Documentation

AddTag()

void cbm::qa::report::Header::AddTag ( std::string_view tag )

inline

Add tag.

Definition at line 27 of file CbmQaReportHeader.h.

References fvsTags.

GetAuthor()

const std::string & cbm::qa::report::Header::GetAuthor ( ) const

inline

Gets author.

Definition at line 34 of file CbmQaReportHeader.h.

References fsAuthor.

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

GetBody()

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

inline

Gets body of the element.

Parameters

engine

A concrete implementation of the Engine to get the element body

Definition at line 31 of file CbmQaReportHeader.h.

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

GetPageHeader()

const std::string & cbm::qa::report::Header::GetPageHeader ( ) const

inline

Gets page header.

Definition at line 37 of file CbmQaReportHeader.h.

References fsPageHeader.

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

GetSetup()

const std::string & cbm::qa::report::Header::GetSetup ( ) const

inline

Gets setup.

Definition at line 40 of file CbmQaReportHeader.h.

References fsSetup.

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

GetSubtitle()

const std::string & cbm::qa::report::Header::GetSubtitle ( ) const

inline

Gets subtitle.

Definition at line 43 of file CbmQaReportHeader.h.

References fsSubtitle.

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

GetTags()

const std::vector< std::string > & cbm::qa::report::Header::GetTags ( ) const

inline

Gets tags.

Definition at line 46 of file CbmQaReportHeader.h.

References fvsTags.

Referenced by cbm::qa::report::BeamerEngine::HeaderBody().

GetTitle()

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

inline

Gets title.

Definition at line 49 of file CbmQaReportHeader.h.

References fsTitle.

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

SetAuthor()

void cbm::qa::report::Header::SetAuthor ( std::string_view author )

inline

Sets author.

Definition at line 52 of file CbmQaReportHeader.h.

References fsAuthor.

SetPageHeader()

void cbm::qa::report::Header::SetPageHeader ( std::string_view pageHeader )

inline

Sets page header.

Definition at line 55 of file CbmQaReportHeader.h.

References fsPageHeader.

SetSetup()

void cbm::qa::report::Header::SetSetup ( std::string_view setup )

inline

Sets setup.

Definition at line 58 of file CbmQaReportHeader.h.

References fsSetup.

SetSubtitle()

void cbm::qa::report::Header::SetSubtitle ( std::string_view subtitle )

inline

Sets subtitle.

Definition at line 61 of file CbmQaReportHeader.h.

References fsSubtitle.

SetTitle()

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

inline

Sets title.

Definition at line 64 of file CbmQaReportHeader.h.

References fsTitle.

Member Data Documentation

fsAuthor

std::string cbm::qa::report::Header::fsAuthor = ""

private

Definition at line 69 of file CbmQaReportHeader.h.

Referenced by GetAuthor(), and SetAuthor().

fsPageHeader

std::string cbm::qa::report::Header::fsPageHeader = ""

private

Placed on top/bottom of the page.

Definition at line 73 of file CbmQaReportHeader.h.

Referenced by GetPageHeader(), and SetPageHeader().

fsSetup

std::string cbm::qa::report::Header::fsSetup = ""

private

Definition at line 70 of file CbmQaReportHeader.h.

Referenced by GetSetup(), and SetSetup().

fsSubtitle

std::string cbm::qa::report::Header::fsSubtitle = ""

private

Definition at line 71 of file CbmQaReportHeader.h.

Referenced by GetSubtitle(), and SetSubtitle().

fsTitle

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

private

Definition at line 72 of file CbmQaReportHeader.h.

Referenced by GetTitle(), and SetTitle().

fvsTags

std::vector<std::string> cbm::qa::report::Header::fvsTags {}

private

Different Tags.

Definition at line 67 of file CbmQaReportHeader.h.

Referenced by AddTag(), and GetTags().

---

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

• CbmQaReportHeader.h