CppBenchmark::ReporterJSON Class Reference

JSON reporter. More...

#include <reporter_json.h>

Inheritance diagram for CppBenchmark::ReporterJSON:

Public Member Functions
	ReporterJSON (std::ostream &stream=std::cout)
	Default class constructor.
	ReporterJSON (const ReporterJSON &)=delete
	ReporterJSON (ReporterJSON &&)=delete
virtual	~ReporterJSON ()=default
ReporterJSON &	operator= (const ReporterJSON &)=delete
ReporterJSON &	operator= (ReporterJSON &&)=delete
void	ReportHeader () override
	Report header.
void	ReportSystem () override
	Report system information.
void	ReportEnvironment () override
	Report environment information.
void	ReportBenchmarksHeader () override
	Report all benchmarks header.
void	ReportBenchmarksFooter () override
	Report all benchmarks footer.
void	ReportBenchmarkHeader () override
	Report current benchmark header.
void	ReportBenchmarkFooter () override
	Report current benchmark footer.
void	ReportBenchmark (const BenchmarkBase &benchmark, const Settings &settings) override
	Report current benchmark information.
void	ReportPhasesHeader () override
	Report all phases header.
void	ReportPhasesFooter () override
	Report all phases footer.
void	ReportPhaseHeader () override
	Report current phase header.
void	ReportPhaseFooter () override
	Report current phase footer.
void	ReportPhase (const PhaseCore &phase, const PhaseMetrics &metrics) override
	Report current phase information.
void	ReportFooter () override
	Report footer.
Public Member Functions inherited from CppBenchmark::Reporter
	Reporter ()=default
	Reporter (const Reporter &)=delete
	Reporter (Reporter &&)=delete
virtual	~Reporter ()=default
Reporter &	operator= (const Reporter &)=delete
Reporter &	operator= (Reporter &&)=delete

Detailed Description

JSON reporter.

Reports benchmarks results in JSON format.

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

Definition at line 24 of file reporter_json.h.

Constructor & Destructor Documentation

ReporterJSON() [1/3]

CppBenchmark::ReporterJSON::ReporterJSON ( 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_json.h.

ReporterJSON() [2/3]

CppBenchmark::ReporterJSON::ReporterJSON ( const ReporterJSON &  )

delete

ReporterJSON() [3/3]

CppBenchmark::ReporterJSON::ReporterJSON ( ReporterJSON &&  )

delete

~ReporterJSON()

virtual CppBenchmark::ReporterJSON::~ReporterJSON ( )

virtualdefault

Member Function Documentation

operator=() [1/2]

ReporterJSON & CppBenchmark::ReporterJSON::operator= ( const ReporterJSON &  )

delete

operator=() [2/2]

ReporterJSON & CppBenchmark::ReporterJSON::operator= ( ReporterJSON &&  )

delete

ReportBenchmark()

void CppBenchmark::ReporterJSON::ReportBenchmark ( const BenchmarkBase &  benchmark, const Settings &  settings  )

overridevirtual

Report current benchmark information.

Parameters

benchmark	- Current benchmark
settings	- Current benchmark settings

Reimplemented from CppBenchmark::Reporter.

Definition at line 95 of file reporter_json.cpp.

ReportBenchmarkFooter()

void CppBenchmark::ReporterJSON::ReportBenchmarkFooter ( )

overridevirtual

Report current benchmark footer.

Reimplemented from CppBenchmark::Reporter.

Definition at line 89 of file reporter_json.cpp.

ReportBenchmarkHeader()

void CppBenchmark::ReporterJSON::ReportBenchmarkHeader ( )

overridevirtual

Report current benchmark header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 80 of file reporter_json.cpp.

ReportBenchmarksFooter()

void CppBenchmark::ReporterJSON::ReportBenchmarksFooter ( )

overridevirtual

Report all benchmarks footer.

Reimplemented from CppBenchmark::Reporter.

Definition at line 74 of file reporter_json.cpp.

ReportBenchmarksHeader()

void CppBenchmark::ReporterJSON::ReportBenchmarksHeader ( )

overridevirtual

Report all benchmarks header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 66 of file reporter_json.cpp.

ReportEnvironment()

void CppBenchmark::ReporterJSON::ReportEnvironment ( )

overridevirtual

Report environment information.

Reimplemented from CppBenchmark::Reporter.

Definition at line 52 of file reporter_json.cpp.

ReportFooter()

void CppBenchmark::ReporterJSON::ReportFooter ( )

overridevirtual

Report footer.

Reimplemented from CppBenchmark::Reporter.

Definition at line 252 of file reporter_json.cpp.

ReportHeader()

void CppBenchmark::ReporterJSON::ReportHeader ( )

overridevirtual

Report header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 33 of file reporter_json.cpp.

ReportPhase()

void CppBenchmark::ReporterJSON::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 134 of file reporter_json.cpp.

ReportPhaseFooter()

void CppBenchmark::ReporterJSON::ReportPhaseFooter ( )

overridevirtual

Report current phase footer.

Reimplemented from CppBenchmark::Reporter.

Definition at line 128 of file reporter_json.cpp.

ReportPhaseHeader()

void CppBenchmark::ReporterJSON::ReportPhaseHeader ( )

overridevirtual

Report current phase header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 119 of file reporter_json.cpp.

ReportPhasesFooter()

void CppBenchmark::ReporterJSON::ReportPhasesFooter ( )

overridevirtual

Report all phases footer.

Reimplemented from CppBenchmark::Reporter.

Definition at line 113 of file reporter_json.cpp.

ReportPhasesHeader()

void CppBenchmark::ReporterJSON::ReportPhasesHeader ( )

overridevirtual

Report all phases header.

Reimplemented from CppBenchmark::Reporter.

Definition at line 105 of file reporter_json.cpp.

ReportSystem()

void CppBenchmark::ReporterJSON::ReportSystem ( )

overridevirtual

Report system information.

Reimplemented from CppBenchmark::Reporter.

Definition at line 39 of file reporter_json.cpp.

---

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

• include/benchmark/reporter_json.h
• source/benchmark/reporter_json.cpp