Class Summary

Inheritance
Object
Summary
Namespace: BenchmarkDotNet.Reports
Assembly: BenchmarkDotNet.dll
Syntax
public class Summary

Constructors

Summary(String, ImmutableArray<BenchmarkReport>, HostEnvironmentInfo, String, String, TimeSpan, CultureInfo, ImmutableArray<ValidationError>)

Declaration
public Summary(string title, ImmutableArray<BenchmarkReport> reports, HostEnvironmentInfo hostEnvironmentInfo, string resultsDirectoryPath, string logFilePath, TimeSpan totalTime, CultureInfo cultureInfo, ImmutableArray<ValidationError> validationErrors)
Parameters
Type Name Description
String title
ImmutableArray<BenchmarkReport> reports
HostEnvironmentInfo hostEnvironmentInfo
String resultsDirectoryPath
String logFilePath
TimeSpan totalTime
CultureInfo cultureInfo
ImmutableArray<ValidationError> validationErrors

Properties

AllRuntimes

Declaration
public string AllRuntimes { get; }
Property Value
Type Description
String

BenchmarksCases

Declaration
public ImmutableArray<BenchmarkCase> BenchmarksCases { get; }
Property Value
Type Description
ImmutableArray<BenchmarkCase>

HasCriticalValidationErrors

Declaration
public bool HasCriticalValidationErrors { get; }
Property Value
Type Description
Boolean

HostEnvironmentInfo

Declaration
public HostEnvironmentInfo HostEnvironmentInfo { get; }
Property Value
Type Description
HostEnvironmentInfo

Item[BenchmarkCase]

Returns a report for the given benchmark or null if there is no a corresponded report.

Declaration
public BenchmarkReport this[BenchmarkCase benchmarkCase] { get; }
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Property Value
Type Description
BenchmarkReport

LogFilePath

Declaration
public string LogFilePath { get; }
Property Value
Type Description
String

Orderer

Declaration
public IOrderer Orderer { get; }
Property Value
Type Description
IOrderer

Reports

Declaration
public ImmutableArray<BenchmarkReport> Reports { get; }
Property Value
Type Description
ImmutableArray<BenchmarkReport>

ResultsDirectoryPath

Declaration
public string ResultsDirectoryPath { get; }
Property Value
Type Description
String

Style

Declaration
public SummaryStyle Style { get; }
Property Value
Type Description
SummaryStyle

Table

Declaration
public SummaryTable Table { get; }
Property Value
Type Description
SummaryTable

Title

Declaration
public string Title { get; }
Property Value
Type Description
String

TotalTime

Declaration
public TimeSpan TotalTime { get; }
Property Value
Type Description
TimeSpan

ValidationErrors

Declaration
public ImmutableArray<ValidationError> ValidationErrors { get; }
Property Value
Type Description
ImmutableArray<ValidationError>

Methods

GetBaseline(String)

Declaration
public BenchmarkCase GetBaseline(string logicalGroupKey)
Parameters
Type Name Description
String logicalGroupKey
Returns
Type Description
BenchmarkCase

GetLogicalGroupKey(BenchmarkCase)

Declaration
public string GetLogicalGroupKey(BenchmarkCase benchmarkCase)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Returns
Type Description
String

GetNonBaselines(String)

Declaration
public IEnumerable<BenchmarkCase> GetNonBaselines(string logicalGroupKey)
Parameters
Type Name Description
String logicalGroupKey
Returns
Type Description
IEnumerable<BenchmarkCase>

GetNumberOfExecutedBenchmarks()

Declaration
public int GetNumberOfExecutedBenchmarks()
Returns
Type Description
Int32

HasBaselines()

Declaration
public bool HasBaselines()
Returns
Type Description
Boolean

HasReport(BenchmarkCase)

Declaration
public bool HasReport(BenchmarkCase benchmarkCase)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Returns
Type Description
Boolean

IsBaseline(BenchmarkCase)

Declaration
public bool IsBaseline(BenchmarkCase benchmarkCase)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Returns
Type Description
Boolean

Extension Methods