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

Comma-separated values (CSV) reporter. More...

#include <reporter_csv.h>

Inheritance diagram for CppBenchmark::ReporterCSV:
CppBenchmark::Reporter

Public Member Functions

 ReporterCSV (std::ostream &stream=std::cout)
 Default class constructor. More...
 
 ReporterCSV (const ReporterCSV &)=delete
 
 ReporterCSV (ReporterCSV &&)=delete
 
virtual ~ReporterCSV ()=default
 
ReporterCSVoperator= (const ReporterCSV &)=delete
 
ReporterCSVoperator= (ReporterCSV &&)=delete
 
void ReportHeader () override
 Report header. More...
 
void ReportPhase (const PhaseCore &phase, const PhaseMetrics &metrics) override
 Report current phase information. More...
 
- Public Member Functions inherited from CppBenchmark::Reporter
 Reporter ()=default
 
 Reporter (const Reporter &)=delete
 
 Reporter (Reporter &&)=delete
 
virtual ~Reporter ()=default
 
Reporteroperator= (const Reporter &)=delete
 
Reporteroperator= (Reporter &&)=delete
 
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 ReportFooter ()
 Report footer. More...
 

Detailed Description

Comma-separated values (CSV) reporter.

Reports benchmarks results in comma-separated values (CSV) format.

More information about comma-separated values format you can find here: https://en.wikipedia.org/wiki/Comma-separated_values

Definition at line 24 of file reporter_csv.h.

Constructor & Destructor Documentation

◆ ReporterCSV() [1/3]

CppBenchmark::ReporterCSV::ReporterCSV ( std::ostream &  stream = std::cout)
inline

Default class constructor.

Initialize reporter with an output stream. Default output stream is std::cout.

Parameters
stream- Output stream

Definition at line 33 of file reporter_csv.h.

◆ ReporterCSV() [2/3]

CppBenchmark::ReporterCSV::ReporterCSV ( const ReporterCSV )
delete

◆ ReporterCSV() [3/3]

CppBenchmark::ReporterCSV::ReporterCSV ( ReporterCSV &&  )
delete

◆ ~ReporterCSV()

virtual CppBenchmark::ReporterCSV::~ReporterCSV ( )
virtualdefault

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReportHeader()

void CppBenchmark::ReporterCSV::ReportHeader ( )
overridevirtual

Report header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 13 of file reporter_csv.cpp.

◆ ReportPhase()

void CppBenchmark::ReporterCSV::ReportPhase ( const PhaseCore phase,
const PhaseMetrics metrics 
)
overridevirtual

Report current phase information.

Parameters
phase- Current phase
metrics- Current phase metrics

Implements CppBenchmark::Reporter.

Definition at line 18 of file reporter_csv.cpp.


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