CppBenchmark  1.0.4.0
C++ Benchmark Library
Public Member Functions | List of all members
CppBenchmark::Reporter Class Referenceabstract

Reporter base class. More...

#include <reporter.h>

Inheritance diagram for CppBenchmark::Reporter:
CppBenchmark::ReporterCSV CppBenchmark::ReporterConsole CppBenchmark::ReporterJSON

Public Member Functions

 Reporter ()=default
 
 Reporter (const Reporter &)=delete
 
 Reporter (Reporter &&)=delete
 
virtual ~Reporter ()=default
 
Reporteroperator= (const Reporter &)=delete
 
Reporteroperator= (Reporter &&)=delete
 
virtual void ReportHeader ()
 Report header. More...
 
virtual void ReportSystem ()
 Report system information. More...
 
virtual void ReportEnvironment ()
 Report environment information. More...
 
virtual void ReportBenchmarksHeader ()
 Report all benchmarks header. More...
 
virtual void ReportBenchmarksFooter ()
 Report all benchmarks footer. More...
 
virtual void ReportBenchmarkHeader ()
 Report current benchmark header. More...
 
virtual void ReportBenchmarkFooter ()
 Report current benchmark footer. More...
 
virtual void ReportBenchmark (const BenchmarkBase &benchmark, const Settings &settings)
 Report current benchmark information. More...
 
virtual void ReportPhasesHeader ()
 Report all phases header. More...
 
virtual void ReportPhasesFooter ()
 Report all phases footer. More...
 
virtual void ReportPhaseHeader ()
 Report current phase header. More...
 
virtual void ReportPhaseFooter ()
 Report current phase footer. More...
 
virtual void ReportPhase (const PhaseCore &phase, const PhaseMetrics &metrics)=0
 Report current phase information. More...
 
virtual void ReportFooter ()
 Report footer. More...
 

Detailed Description

Reporter base class.

Provides interface to report benchmark results.

Definition at line 20 of file reporter.h.

Constructor & Destructor Documentation

◆ Reporter() [1/3]

CppBenchmark::Reporter::Reporter ( )
default

◆ Reporter() [2/3]

CppBenchmark::Reporter::Reporter ( const Reporter )
delete

◆ Reporter() [3/3]

CppBenchmark::Reporter::Reporter ( Reporter &&  )
delete

◆ ~Reporter()

virtual CppBenchmark::Reporter::~Reporter ( )
virtualdefault

Member Function Documentation

◆ operator=() [1/2]

Reporter& CppBenchmark::Reporter::operator= ( const Reporter )
delete

◆ operator=() [2/2]

Reporter& CppBenchmark::Reporter::operator= ( Reporter &&  )
delete

◆ ReportBenchmark()

virtual void CppBenchmark::Reporter::ReportBenchmark ( const BenchmarkBase benchmark,
const Settings settings 
)
inlinevirtual

Report current benchmark information.

Parameters
benchmark- Current benchmark
settings- Current benchmark settings

Reimplemented in CppBenchmark::ReporterJSON, and CppBenchmark::ReporterConsole.

Definition at line 50 of file reporter.h.

◆ ReportBenchmarkFooter()

virtual void CppBenchmark::Reporter::ReportBenchmarkFooter ( )
inlinevirtual

Report current benchmark footer.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 44 of file reporter.h.

◆ ReportBenchmarkHeader()

virtual void CppBenchmark::Reporter::ReportBenchmarkHeader ( )
inlinevirtual

Report current benchmark header.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 42 of file reporter.h.

◆ ReportBenchmarksFooter()

virtual void CppBenchmark::Reporter::ReportBenchmarksFooter ( )
inlinevirtual

Report all benchmarks footer.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 40 of file reporter.h.

◆ ReportBenchmarksHeader()

virtual void CppBenchmark::Reporter::ReportBenchmarksHeader ( )
inlinevirtual

Report all benchmarks header.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 38 of file reporter.h.

◆ ReportEnvironment()

virtual void CppBenchmark::Reporter::ReportEnvironment ( )
inlinevirtual

Report environment information.

Reimplemented in CppBenchmark::ReporterJSON, and CppBenchmark::ReporterConsole.

Definition at line 36 of file reporter.h.

◆ ReportFooter()

virtual void CppBenchmark::Reporter::ReportFooter ( )
inlinevirtual

Report footer.

Reimplemented in CppBenchmark::ReporterJSON, and CppBenchmark::ReporterConsole.

Definition at line 66 of file reporter.h.

◆ ReportHeader()

virtual void CppBenchmark::Reporter::ReportHeader ( )
inlinevirtual

Report header.

Reimplemented in CppBenchmark::ReporterJSON, CppBenchmark::ReporterCSV, and CppBenchmark::ReporterConsole.

Definition at line 32 of file reporter.h.

◆ ReportPhase()

virtual void CppBenchmark::Reporter::ReportPhase ( const PhaseCore phase,
const PhaseMetrics metrics 
)
pure virtual

Report current phase information.

Parameters
phase- Current phase
metrics- Current phase metrics

Implemented in CppBenchmark::ReporterJSON, CppBenchmark::ReporterCSV, and CppBenchmark::ReporterConsole.

◆ ReportPhaseFooter()

virtual void CppBenchmark::Reporter::ReportPhaseFooter ( )
inlinevirtual

Report current phase footer.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 58 of file reporter.h.

◆ ReportPhaseHeader()

virtual void CppBenchmark::Reporter::ReportPhaseHeader ( )
inlinevirtual

Report current phase header.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 56 of file reporter.h.

◆ ReportPhasesFooter()

virtual void CppBenchmark::Reporter::ReportPhasesFooter ( )
inlinevirtual

Report all phases footer.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 54 of file reporter.h.

◆ ReportPhasesHeader()

virtual void CppBenchmark::Reporter::ReportPhasesHeader ( )
inlinevirtual

Report all phases header.

Reimplemented in CppBenchmark::ReporterJSON.

Definition at line 52 of file reporter.h.

◆ ReportSystem()

virtual void CppBenchmark::Reporter::ReportSystem ( )
inlinevirtual

Report system information.

Reimplemented in CppBenchmark::ReporterJSON, and CppBenchmark::ReporterConsole.

Definition at line 34 of file reporter.h.


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