Class ReportTask

Report (abstract) task - all report tasks extend this task.

Inheritance

object

PerfTask

ReportTask

RepAllTask

RepSumByNameRoundTask

RepSumByNameTask

RepSumByPrefTask

Implements

IDisposable

Inherited Members

PerfTask.m_logStep

PerfTask.m_params

PerfTask.NEW_LINE

PerfTask.SetRunInBackground(int)

PerfTask.RunInBackground

PerfTask.BackgroundDeltaPriority

PerfTask.Stop

PerfTask.StopNow()

PerfTask.Clone()

PerfTask.Dispose()

PerfTask.Dispose(bool)

PerfTask.RunAndMaybeStats(bool)

PerfTask.DoLogic()

PerfTask.GetName()

PerfTask.SetName(string)

PerfTask.RunData

PerfTask.Depth

PerfTask.ToString()

PerfTask.GetLogMessage(int)

PerfTask.Setup()

PerfTask.TearDown()

PerfTask.SupportsParams

PerfTask.SetParams(string)

PerfTask.Params

PerfTask.DisableCounting

PerfTask.AlgLineNum

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Benchmarks.ByTask.Tasks

Assembly: Lucene.Net.Benchmark.dll

Syntax

public abstract class ReportTask : PerfTask, IDisposable

Constructors

ReportTask(PerfRunData)

Report (abstract) task - all report tasks extend this task.

Declaration

protected ReportTask(PerfRunData runData)

Parameters

Type	Name	Description
PerfRunData	runData

Fields

COLS

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string[] COLS

Field Value

Type	Description
string[]

ELAPSED

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string ELAPSED

Field Value

Type	Description
string

OP

Get a textual summary of the benchmark results, average from all test runs.

Declaration

protected static readonly string OP

Field Value

Type	Description
string

RECCNT

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string RECCNT

Field Value

Type	Description
string

RECSEC

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string RECSEC

Field Value

Type	Description
string

ROUND

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string ROUND

Field Value

Type	Description
string

RUNCNT

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string RUNCNT

Field Value

Type	Description
string

TOTMEM

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string TOTMEM

Field Value

Type	Description
string

USEDMEM

Report (abstract) task - all report tasks extend this task.

Declaration

protected static readonly string USEDMEM

Field Value

Type	Description
string

newline

From here start the code used to generate the reports. Subclasses would use this part to generate reports.

Declaration

protected static readonly string newline

Field Value

Type	Description
string

Properties

ShouldNeverLogAtStart

Report (abstract) task - all report tasks extend this task.

Declaration

protected override bool ShouldNeverLogAtStart { get; }

Property Value

Type	Description
bool

Overrides

PerfTask.ShouldNeverLogAtStart

See Also

ShouldNeverLogAtStart

ShouldNotRecordStats

Report (abstract) task - all report tasks extend this task.

Declaration

protected override bool ShouldNotRecordStats { get; }

Property Value

Type	Description
bool

Overrides

PerfTask.ShouldNotRecordStats

See Also

ShouldNotRecordStats

Methods

GenPartialReport(int, LinkedDictionary<string, TaskStats>, int)

Report (abstract) task - all report tasks extend this task.

Declaration

protected virtual Report GenPartialReport(int reported, LinkedDictionary<string, TaskStats> partOfTasks, int totalSize)

Parameters

Type	Name	Description
int	reported
LinkedDictionary<string, TaskStats>	partOfTasks
int	totalSize

Returns

Type	Description
Report

LongestOp(IEnumerable<TaskStats>)

Find the longest op name out of completed tasks.

Declaration

protected virtual string LongestOp(IEnumerable<TaskStats> taskStats)

Parameters

Type	Name	Description
IEnumerable<TaskStats>	taskStats	Completed tasks to be considered.

Returns

Type	Description
string	The longest op name out of completed tasks.

TableTitle(string)

Compute a title line for a report table.

Declaration

protected virtual string TableTitle(string longestOp)

Parameters

Type	Name	Description
string	longestOp	Size of longest op name in the table.

Returns

Type	Description
string	The table title line.

TaskReportLine(string, TaskStats)

Compute a report line for the given task stat.

Declaration

protected virtual string TaskReportLine(string longestOp, TaskStats stat)

Parameters

Type	Name	Description
string	longestOp	Size of longest op name in the table.
TaskStats	stat	Task stat to be printed.

Returns

Type	Description
string	The report line.

Implements

IDisposable