Class Characteristic

Namespace

BenchmarkDotNet.Characteristics

Assembly

BenchmarkDotNet.dll

public abstract class Characteristic

Inheritance

object

Characteristic

Derived

Characteristic<T>

Extension Methods

CharacteristicHelper.IsPresentableCharacteristic(Characteristic, bool)

Constructors

Characteristic(string, Type, Type, object, bool, bool)

protected Characteristic(string id, Type characteristicType, Type declaringType, object fallbackValue, bool ignoreOnApply, bool dontShowInSummary = false)

Parameters

id string

characteristicType Type

declaringType Type

fallbackValue object

ignoreOnApply bool

dontShowInSummary bool

Fields

EmptyValue

public static readonly object EmptyValue

Field Value

object

Properties

CharacteristicType

public Type CharacteristicType { get; }

Property Value

Type

DeclaringType

public Type DeclaringType { get; }

Property Value

Type

DontShowInSummary

public bool DontShowInSummary { get; }

Property Value

bool

FullId

public string FullId { get; }

Property Value

string

HasChildCharacteristics

public bool HasChildCharacteristics { get; }

Property Value

bool

Id

public string Id { get; }

Property Value

string

IgnoreOnApply

public bool IgnoreOnApply { get; }

Property Value

bool

this[CharacteristicObject]

public object? this[CharacteristicObject obj] { get; set; }

Parameters

obj CharacteristicObject

Property Value

object

Methods

CreateHidden<TOwner, T>(string)

public static Characteristic<T> CreateHidden<TOwner, T>(string memberName) where TOwner : CharacteristicObject

Parameters

memberName string

Returns

Characteristic<T>

Type Parameters

TOwner

T

CreateIgnoreOnApply<TOwner, T>(string)

public static Characteristic<T> CreateIgnoreOnApply<TOwner, T>(string memberName) where TOwner : CharacteristicObject

Parameters

memberName string

Returns

Characteristic<T>

Type Parameters

TOwner

T

Create<TOwner, T>(string)

public static Characteristic<T> Create<TOwner, T>(string memberName) where TOwner : CharacteristicObject

Parameters

memberName string

Returns

Characteristic<T>

Type Parameters

TOwner

T

Create<TOwner, T>(string, Func<CharacteristicObject, T, T>, T, bool)

public static Characteristic<T> Create<TOwner, T>(string memberName, Func<CharacteristicObject, T, T> resolver, T fallbackValue, bool ignoreOnApply) where TOwner : CharacteristicObject

Parameters

memberName string

resolver Func<CharacteristicObject, T, T>

fallbackValue T

ignoreOnApply bool

Returns

Characteristic<T>

Type Parameters

TOwner

T

Create<TOwner, T>(string, T)

public static Characteristic<T> Create<TOwner, T>(string memberName, T fallbackValue) where TOwner : CharacteristicObject

Parameters

memberName string

fallbackValue T

Returns

Characteristic<T>

Type Parameters

TOwner

T

ToString()

public override string ToString()

Returns

string