Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SetPropTask

    Set a performance test configuration property. A property may have a single value, or a sequence of values, separated by ":". If a sequence of values is specified, each time a new round starts, the next (cyclic) value is taken.

    Other side effects: none.

    Takes mandatory param: "name,value" pair.
    Inheritance
    object
    PerfTask
    SetPropTask
    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.GetName()
    PerfTask.SetName(string)
    PerfTask.RunData
    PerfTask.Depth
    PerfTask.ToString()
    PerfTask.GetLogMessage(int)
    PerfTask.ShouldNeverLogAtStart
    PerfTask.ShouldNotRecordStats
    PerfTask.Setup()
    PerfTask.TearDown()
    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 class SetPropTask : PerfTask, IDisposable

    Constructors

    SetPropTask(PerfRunData)

    Set a performance test configuration property. A property may have a single value, or a sequence of values, separated by ":". If a sequence of values is specified, each time a new round starts, the next (cyclic) value is taken.

    Other side effects: none.

    Takes mandatory param: "name,value" pair.
    Declaration
    public SetPropTask(PerfRunData runData)
    Parameters
    Type Name Description
    PerfRunData runData
    See Also
    NewRoundTask

    Properties

    SupportsParams

    Set a performance test configuration property. A property may have a single value, or a sequence of values, separated by ":". If a sequence of values is specified, each time a new round starts, the next (cyclic) value is taken.

    Other side effects: none.

    Takes mandatory param: "name,value" pair.
    Declaration
    public override bool SupportsParams { get; }
    Property Value
    Type Description
    bool
    Overrides
    PerfTask.SupportsParams
    See Also
    SupportsParams

    Methods

    DoLogic()

    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.

    Declaration
    public override int DoLogic()
    Returns
    Type Description
    int

    Number of work items done by this task.

    Overrides
    PerfTask.DoLogic()
    See Also
    NewRoundTask

    SetParams(string)

    Set the params (property name and value).

    Declaration
    public override void SetParams(string @params)
    Parameters
    Type Name Description
    string params

    Property name and value separated by ','.

    Overrides
    PerfTask.SetParams(string)
    See Also
    NewRoundTask

    Implements

    IDisposable

    See Also

    NewRoundTask
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.