| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PerfTask |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PerfTask |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="benchmark/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask" class="text-break">Class PerfTask |
| </h1> |
| <div class="markdown level0 summary"><p>An abstract task to be tested for performance.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">PerfTask</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.AddDocTask.html">AddDocTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.AddIndexesTask.html">AddIndexesTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.html">AnalyzerFactoryTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ClearStatsTask.html">ClearStatsTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CloseIndexTask.html">CloseIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CloseReaderTask.html">CloseReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CloseTaxonomyIndexTask.html">CloseTaxonomyIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CloseTaxonomyReaderTask.html">CloseTaxonomyReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CommitIndexTask.html">CommitIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CommitTaxonomyIndexTask.html">CommitTaxonomyIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ConsumeContentSourceTask.html">ConsumeContentSourceTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CreateIndexTask.html">CreateIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.CreateTaxonomyIndexTask.html">CreateTaxonomyIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ForceMergeTask.html">ForceMergeTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NearRealtimeReaderTask.html">NearRealtimeReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NewAnalyzerTask.html">NewAnalyzerTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NewCollationAnalyzerTask.html">NewCollationAnalyzerTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NewLocaleTask.html">NewLocaleTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NewRoundTask.html">NewRoundTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.OpenIndexTask.html">OpenIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.OpenReaderTask.html">OpenReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.OpenTaxonomyIndexTask.html">OpenTaxonomyIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.OpenTaxonomyReaderTask.html">OpenTaxonomyReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PrintReaderTask.html">PrintReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html">ReadTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTokensTask.html">ReadTokensTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReopenReaderTask.html">ReopenReaderTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReportTask.html">ReportTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ResetInputsTask.html">ResetInputsTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.RollbackIndexTask.html">RollbackIndexTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SetPropTask.html">SetPropTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.TaskSequence.html">TaskSequence</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.UpdateDocTask.html">UpdateDocTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WaitForMergesTask.html">WaitForMergesTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WaitTask.html">WaitTask</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.html">WriteLineDocTask</a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.html">Lucene.Net.Benchmarks.ByTask.Tasks</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class PerfTask : IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>Every performance task extends this class, and provides its own |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> method, which performs the actual task. |
| <p> |
| Tasks performing some work that should be measured for the task, can override |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup">Setup()</a> and/or <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown">TearDown()</a> and place that work there. |
| <p> |
| Relevant properties: |
| <ul><li>task.max.depth.log</li></ul> |
| <p> |
| Also supports the following logging attributes: |
| <ul><li>log.step |
| specifies how often to log messages about the current running |
| task. Default is 1000 <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> invocations. Set to -1 to disable |
| logging. |
| </li><li>log.step.[class Task Name] |
| specifies the same as 'log.step', only for a |
| particular task name. For example, log.step.AddDoc will be applied only for |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.AddDocTask.html">AddDocTask</a>. It's a way to control |
| per task logging settings. If you want to omit logging for any other task, |
| include log.step=-1. The syntax is "log.step." together with the Task's |
| 'short' name (i.e., without the 'Task' part). |
| </li></ul></p> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.%23ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L124">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.#ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)">PerfTask(PerfRunData)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public PerfTask(PerfRunData runData)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Benchmarks.ByTask.PerfRunData.html">PerfRunData</a></td> |
| <td><span class="parametername">runData</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_logStep.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.m_logStep%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L73">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_logStep" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.m_logStep">m_logStep</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected int m_logStep</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_params.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.m_params%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L77">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_params" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.m_params">m_params</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected string m_params</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_NEW_LINE.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.NEW_LINE%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L85">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_NEW_LINE" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.NEW_LINE">NEW_LINE</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected static readonly string NEW_LINE</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.AlgLineNum%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L353">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.AlgLineNum*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.AlgLineNum">AlgLineNum</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int AlgLineNum { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.BackgroundDeltaPriority%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.BackgroundDeltaPriority*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.BackgroundDeltaPriority">BackgroundDeltaPriority</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int BackgroundDeltaPriority { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Depth%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L233">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Depth*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Depth">Depth</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the depth.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int Depth { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DisableCounting%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L347">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DisableCounting*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DisableCounting">DisableCounting</h4> |
| <div class="markdown level1 summary"><p>Return <code>true</code> if counting is disabled for this task.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool DisableCounting { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Params%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L342">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Params*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Params">Params</h4> |
| <div class="markdown level1 summary"><p>Gets the Params.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Params { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunData%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L228">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunData*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunData">RunData</h4> |
| <div class="markdown level1 summary"><p>Gets the run data.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual PerfRunData RunData { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Benchmarks.ByTask.PerfRunData.html">PerfRunData</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunInBackground%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunInBackground*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunInBackground">RunInBackground</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool RunInBackground { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNeverLogAtStart%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L282">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNeverLogAtStart*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNeverLogAtStart">ShouldNeverLogAtStart</h4> |
| <div class="markdown level1 summary"><p>Tasks that should never log at start can override this. |
| Returns <code>true</code> if this task should never log when it start.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual bool ShouldNeverLogAtStart { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNotRecordStats%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L288">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNotRecordStats*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ShouldNotRecordStats">ShouldNotRecordStats</h4> |
| <div class="markdown level1 summary"><p>Tasks that should not record statistics can override this. |
| Returns <code>true</code> if this task should never record its statistics.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual bool ShouldNotRecordStats { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Stop%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L114">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Stop*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Stop">Stop</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected bool Stop { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SupportsParams%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L324">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SupportsParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SupportsParams">SupportsParams</h4> |
| <div class="markdown level1 summary"><p>Sub classes that support parameters must override this method to return |
| <code>true</code> if this task supports command line params.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool SupportsParams { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Clone%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Clone*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Clone">Clone()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual object Clone()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose">Dispose()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Dispose()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L161">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_System_Boolean_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Dispose(System.Boolean)">Dispose(Boolean)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">disposing</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DoLogic%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L202">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DoLogic*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.DoLogic">DoLogic()</h4> |
| <div class="markdown level1 summary"><p>Perform the task once (ignoring repetitions specification). |
| Return number of work items done by this task. |
| For indexing that can be number of docs added. |
| For warming that can be number of scanned items, etc.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract int DoLogic()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>Number of work items done by this task.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetLogMessage(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L273">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetLogMessage*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetLogMessage(System.Int32)">GetLogMessage(Int32)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual string GetLogMessage(int recsCount)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">recsCount</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L207">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetName*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.GetName">GetName()</h4> |
| <div class="markdown level1 summary"><p>Returns the name.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string GetName()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunAndMaybeStats(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L170">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunAndMaybeStats*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_System_Boolean_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.RunAndMaybeStats(System.Boolean)">RunAndMaybeStats(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Run the task, record statistics.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int RunAndMaybeStats(bool reportStats)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">reportStats</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>Number of work items done by this task.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetName(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L220">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetName*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetName(System.String)">SetName(String)</h4> |
| <div class="markdown level1 summary"><p>Sets the name.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void SetName(string name)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>The name to set.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetParams_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetParams(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L330">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetParams_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetParams(System.String)">SetParams(String)</h4> |
| <div class="markdown level1 summary"><p>Set the params of this task.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetParams(string params)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">params</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>For tasks supporting command line parameters.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetRunInBackground(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L99">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetRunInBackground*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.SetRunInBackground(System.Int32)">SetRunInBackground(Int32)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetRunInBackground(int deltaPri)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">deltaPri</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Setup%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L298">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Setup*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.Setup">Setup()</h4> |
| <div class="markdown level1 summary"><p>Task setup work that should not be measured for that specific task. By |
| default it does nothing, but tasks can implement this, moving work from |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> to this method. Only the work done in <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> |
| is measured for this task. Notice that higher level (sequence) tasks |
| containing this task would then measure larger time than the sum of their |
| contained tasks.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Setup()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.StopNow%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.StopNow*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.StopNow">StopNow()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void StopNow()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.TearDown%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L310">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.TearDown*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.TearDown">TearDown()</h4> |
| <div class="markdown level1 summary"><p>Task teardown work that should not be measured for that specific task. By |
| default it does nothing, but tasks can implement this, moving work from |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> to this method. Only the work done in <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">DoLogic()</a> |
| is measured for this task. Notice that higher level (sequence) tasks |
| containing this task would then measure larger time than the sum of their<br>contained tasks.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void TearDown()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L247">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ToString*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.ToString">ToString()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string ToString()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</span></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/PerfTask.cs/#L61" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
