cpp-stat-bench 0.24.0
Benchmark library with statistics for C++.
Loading...
Searching...
No Matches
stat_bench::reporter::IReporter Class Referenceabstract

Interface of reporters. More...

#include <stat_bench/reporter/i_reporter.h>

+ Inheritance diagram for stat_bench::reporter::IReporter:
+ Collaboration diagram for stat_bench::reporter::IReporter:

Public Member Functions

 IReporter (const IReporter &)=delete
 
 IReporter (IReporter &&)=delete
 
virtual ~IReporter ()=default
 Destructor.
 
virtual void case_finished (const BenchmarkFullName &case_info)=0
 Finished a case of a benchmark.
 
virtual void case_starts (const BenchmarkFullName &case_info)=0
 Start a case of a benchmark.
 
virtual void experiment_finished (const clock::SystemTimePoint &time_stamp)=0
 Finished an experiment.
 
virtual void experiment_starts (const clock::SystemTimePoint &time_stamp)=0
 Start an experiment.
 
virtual void group_finished (const BenchmarkGroupName &name)=0
 Finished a group of benchmarks.
 
virtual void group_starts (const BenchmarkGroupName &name, const bench_impl::BenchmarkGroupConfig &config)=0
 Start a group of benchmarks.
 
virtual void measurement_failed (const BenchmarkFullName &case_info, const BenchmarkCondition &cond, const std::exception_ptr &error)=0
 Failed a measurement.
 
virtual void measurement_succeeded (const measurer::Measurement &measurement)=0
 Successfully finished a measurement.
 
virtual void measurer_finished (const measurer::MeasurerName &name)=0
 Finished benchmarks using a measurer.
 
virtual void measurer_starts (const measurer::MeasurerName &name)=0
 Start benchmarks using a measurer.
 
auto operator= (const IReporter &) -> IReporter &=delete
 
auto operator= (IReporter &&) -> IReporter &=delete
 

Protected Member Functions

 IReporter ()=default
 Constructor.
 

Detailed Description

Interface of reporters.

Definition at line 38 of file i_reporter.h.

Member Function Documentation

◆ case_finished()

virtual void stat_bench::reporter::IReporter::case_finished ( const BenchmarkFullName & case_info)
pure virtual

Finished a case of a benchmark.

Parameters
[in]case_infoInformation.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ case_starts()

virtual void stat_bench::reporter::IReporter::case_starts ( const BenchmarkFullName & case_info)
pure virtual

Start a case of a benchmark.

Parameters
[in]case_infoInformation.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ experiment_finished()

virtual void stat_bench::reporter::IReporter::experiment_finished ( const clock::SystemTimePoint & time_stamp)
pure virtual

Finished an experiment.

Parameters
[in]time_stampTime stamp.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ experiment_starts()

virtual void stat_bench::reporter::IReporter::experiment_starts ( const clock::SystemTimePoint & time_stamp)
pure virtual

Start an experiment.

Parameters
[in]time_stampTime stamp.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ group_finished()

virtual void stat_bench::reporter::IReporter::group_finished ( const BenchmarkGroupName & name)
pure virtual

Finished a group of benchmarks.

Parameters
[in]nameGroup name.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ group_starts()

virtual void stat_bench::reporter::IReporter::group_starts ( const BenchmarkGroupName & name,
const bench_impl::BenchmarkGroupConfig & config )
pure virtual

Start a group of benchmarks.

Parameters
[in]nameGroup name.
[in]configConfiguration.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ measurement_failed()

virtual void stat_bench::reporter::IReporter::measurement_failed ( const BenchmarkFullName & case_info,
const BenchmarkCondition & cond,
const std::exception_ptr & error )
pure virtual

Failed a measurement.

Parameters
[in]case_infoInformation of the case.
[in]condCondition.
[in]errorError.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ measurement_succeeded()

virtual void stat_bench::reporter::IReporter::measurement_succeeded ( const measurer::Measurement & measurement)
pure virtual

Successfully finished a measurement.

Parameters
[in]measurementMeasurement.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ measurer_finished()

virtual void stat_bench::reporter::IReporter::measurer_finished ( const measurer::MeasurerName & name)
pure virtual

Finished benchmarks using a measurer.

Parameters
[in]nameMeasurer name.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.

◆ measurer_starts()

virtual void stat_bench::reporter::IReporter::measurer_starts ( const measurer::MeasurerName & name)
pure virtual

Start benchmarks using a measurer.

Parameters
[in]nameMeasurer name.

Implemented in stat_bench::reporter::ConsoleReporter, stat_bench::reporter::DataFileReporterBase, and stat_bench::reporter::PlotReporter.


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