Class Argos::BenchmarkReporter

ClassList > Argos > BenchmarkReporter

Google Benchmark reporter that aggregates per-iteration results into a structured BenchmarkResult .More...

#include <reporter.h>

Inherits the following classes: benchmark::BenchmarkReporter

Public Functions

Type	Name
void	Finalize () override Finalize the report (delegates to the console reporter).
bool	ReportContext (const Context & context) override Capture context information (date, CPU, frequency).
void	ReportRuns (const std::vector< Run > & report) override Aggregate iteration runs into per-line BenchmarkResultLine entries.
const BenchmarkResultMetadata &	metadata () const Read the captured metadata.
const BenchmarkResult &	result () const Read the full result (metadata + lines).
const std::vector< BenchmarkResultLine > &	results () const Read the aggregated per-iteration lines.

Detailed Description

Internally it delegates console output to a benchmark::ConsoleReporter while it builds the BenchmarkResult that downstream formatters (XLSX, ...) consume.

Public Functions Documentation

function Finalize

Finalize the report (delegates to the console reporter).

void Argos::BenchmarkReporter::Finalize () override

function ReportContext

Capture context information (date, CPU, frequency).

bool Argos::BenchmarkReporter::ReportContext (
    const Context & context
) override

Parameters:

context Context provided by Google Benchmark.

Returns:

Always true to let the run continue.

function ReportRuns

Aggregate iteration runs into per-line BenchmarkResultLine entries.

void Argos::BenchmarkReporter::ReportRuns (
    const std::vector< Run > & report
) override

Parameters:

report Runs produced by Google Benchmark.

function metadata

Read the captured metadata.

const BenchmarkResultMetadata & Argos::BenchmarkReporter::metadata () const

Returns:

Reference to the metadata block.

function result

Read the full result (metadata + lines).

const BenchmarkResult & Argos::BenchmarkReporter::result () const

Returns:

Reference to the full result.

function results

Read the aggregated per-iteration lines.

const std::vector< BenchmarkResultLine > & Argos::BenchmarkReporter::results () const

Returns:

Reference to the line vector.

The documentation for this class was generated from the following file benchmark/reporter/reporter.h