souffle  2.0.2-371-g6315b36
Public Member Functions | Static Private Member Functions | Private Attributes
souffle::DebugReportSection Class Reference

Class representing a section of a HTML report. More...

#include <DebugReport.h>

Collaboration diagram for souffle::DebugReportSection:
Collaboration graph

Public Member Functions

 DebugReportSection (std::string id, std::string title, std::string body)
 
 DebugReportSection (std::string id, std::string title, std::vector< DebugReportSection > subsections, std::string body)
 
bool hasSubsections () const
 
void printContent (std::ostream &out) const
 Outputs the HTML code for the content of the section to the given stream, consisting of the title header, the body text, followed by the content for each subsection. More...
 
void printIndex (std::ostream &out) const
 Outputs the HTML code for the index to the given stream, consisting of a link to the section body followed by a list of the indices for each subsection. More...
 
void printTitle (std::ostream &out) const
 Outputs the HTML code for the title header to the given stream. More...
 

Static Private Member Functions

static std::string generateUniqueID (std::string id)
 

Private Attributes

std::string body
 
std::string id
 
std::vector< DebugReportSectionsubsections
 
std::string title
 

Detailed Description

Class representing a section of a HTML report.

Consists of a unique identifier, a title, a number of subsections, and the HTML code for the body of the section.

Definition at line 39 of file DebugReport.h.

Constructor & Destructor Documentation

◆ DebugReportSection() [1/2]

souffle::DebugReportSection::DebugReportSection ( std::string  id,
std::string  title,
std::string  body 
)
inline

Definition at line 47 of file DebugReport.h.

◆ DebugReportSection() [2/2]

souffle::DebugReportSection::DebugReportSection ( std::string  id,
std::string  title,
std::vector< DebugReportSection subsections,
std::string  body 
)
inline

Definition at line 50 of file DebugReport.h.

Member Function Documentation

◆ generateUniqueID()

static std::string souffle::DebugReportSection::generateUniqueID ( std::string  id)
inlinestaticprivate

Definition at line 84 of file DebugReport.h.

87  {

◆ hasSubsections()

bool souffle::DebugReportSection::hasSubsections ( ) const
inline

Definition at line 74 of file DebugReport.h.

81  {

◆ printContent()

void souffle::DebugReportSection::printContent ( std::ostream &  out) const

Outputs the HTML code for the content of the section to the given stream, consisting of the title header, the body text, followed by the content for each subsection.

◆ printIndex()

void souffle::DebugReportSection::printIndex ( std::ostream &  out) const

Outputs the HTML code for the index to the given stream, consisting of a link to the section body followed by a list of the indices for each subsection.

◆ printTitle()

void souffle::DebugReportSection::printTitle ( std::ostream &  out) const

Outputs the HTML code for the title header to the given stream.

Field Documentation

◆ body

std::string souffle::DebugReportSection::body
private

Definition at line 82 of file DebugReport.h.

◆ id

std::string souffle::DebugReportSection::id
private

Definition at line 79 of file DebugReport.h.

◆ subsections

std::vector<DebugReportSection> souffle::DebugReportSection::subsections
private

Definition at line 81 of file DebugReport.h.

◆ title

std::string souffle::DebugReportSection::title
private

Definition at line 80 of file DebugReport.h.


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