C# Class BenchmarkDotNet.Reports.Summary

Show file Open project: dotnet/BenchmarkDotNet Class Usage Examples

Private Properties

Property	Type	Description
BuildAllRuntimes	string
GetBaseline	BenchmarkCase
GetConfiguredOrdererOrDefaultOne	IOrderer
GetConfiguredSummaryStyleOrDefaultOne	BenchmarkDotNet.Reports.SummaryStyle
GetLogicalGroupKey	string
GetNonBaselines	IEnumerable
GetTable	BenchmarkDotNet.Reports.SummaryTable
HasReport	bool
Join	Summary
NothingToRun	Summary
ValidationFailed	Summary

Public Methods

Method	Description
GetNumberOfExecutedBenchmarks ( ) : int
HasBaselines ( ) : bool
IsBaseline ( BenchmarkCase benchmarkCase ) : bool
Summary ( string title, ImmutableArray reports, HostEnvironmentInfo hostEnvironmentInfo, string resultsDirectoryPath, string logFilePath, TimeSpan totalTime, CultureInfo cultureInfo, ImmutableArray validationErrors, ImmutableArray columnHidingRules ) : System
this ( BenchmarkCase benchmarkCase ) : BenchmarkReport	Returns a report for the given benchmark or null if there is no a corresponded report.

Private Methods

Method	Description
BuildAllRuntimes ( HostEnvironmentInfo hostEnvironmentInfo, IEnumerable reports ) : string
GetBaseline ( string logicalGroupKey ) : BenchmarkCase
GetConfiguredOrdererOrDefaultOne ( IEnumerable configs ) : IOrderer
GetConfiguredSummaryStyleOrDefaultOne ( ImmutableArray benchmarkCases ) : BenchmarkDotNet.Reports.SummaryStyle
GetLogicalGroupKey ( BenchmarkCase benchmarkCase ) : string
GetNonBaselines ( string logicalGroupKey ) : IEnumerable
GetTable ( BenchmarkDotNet.Reports.SummaryStyle style ) : BenchmarkDotNet.Reports.SummaryTable
HasReport ( BenchmarkCase benchmarkCase ) : bool
Join ( List summaries, ClockSpan clockSpan ) : Summary
NothingToRun ( string title, string resultsDirectoryPath, string logFilePath ) : Summary
ValidationFailed ( string title, string resultsDirectoryPath, string logFilePath, ImmutableArray validationErrors ) : Summary

Method Details

GetNumberOfExecutedBenchmarks() public method

public GetNumberOfExecutedBenchmarks ( ) : int
return	int

HasBaselines() public method

public HasBaselines ( ) : bool
return	bool

IsBaseline() public method

public IsBaseline ( BenchmarkCase benchmarkCase ) : bool
benchmarkCase	BenchmarkCase
return	bool

Summary() public method

public Summary ( string title, ImmutableArray reports, HostEnvironmentInfo hostEnvironmentInfo, string resultsDirectoryPath, string logFilePath, TimeSpan totalTime, CultureInfo cultureInfo, ImmutableArray validationErrors, ImmutableArray columnHidingRules ) : System
title	string
reports	ImmutableArray
hostEnvironmentInfo	HostEnvironmentInfo
resultsDirectoryPath	string
logFilePath	string
totalTime	TimeSpan
cultureInfo	CultureInfo
validationErrors	ImmutableArray
columnHidingRules	ImmutableArray
return	System

this() public method

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

public this ( BenchmarkCase benchmarkCase ) : BenchmarkReport
benchmarkCase	BenchmarkCase
return	BenchmarkReport