Class Characteristic

Inheritance
Object
Characteristic
Characteristic<T>
Namespace: BenchmarkDotNet.Characteristics
Assembly: BenchmarkDotNet.dll
Syntax
public abstract class Characteristic

Constructors

Characteristic(String, Type, Type, Object, Boolean, Boolean)

Declaration
protected Characteristic(string id, Type characteristicType, Type declaringType, object fallbackValue, bool ignoreOnApply, bool dontShowInSummary = false)
Parameters
Type Name Description
String id
Type characteristicType
Type declaringType
Object fallbackValue
Boolean ignoreOnApply
Boolean dontShowInSummary

Fields

EmptyValue

Declaration
public static readonly object EmptyValue
Field Value
Type Description
Object

Properties

CharacteristicType

Declaration
public Type CharacteristicType { get; }
Property Value
Type Description
Type

DeclaringType

Declaration
public Type DeclaringType { get; }
Property Value
Type Description
Type

DontShowInSummary

Declaration
public bool DontShowInSummary { get; }
Property Value
Type Description
Boolean

FullId

Declaration
public string FullId { get; }
Property Value
Type Description
String

HasChildCharacteristics

Declaration
public bool HasChildCharacteristics { get; }
Property Value
Type Description
Boolean

Id

Declaration
public string Id { get; }
Property Value
Type Description
String

IgnoreOnApply

Declaration
public bool IgnoreOnApply { get; }
Property Value
Type Description
Boolean

Item[CharacteristicObject]

Declaration
public object this[CharacteristicObject obj] { get; set; }
Parameters
Type Name Description
CharacteristicObject obj
Property Value
Type Description
Object

Methods

Create<TOwner, T>(String)

Declaration
public static Characteristic<T> Create<TOwner, T>(string memberName)
    where TOwner : CharacteristicObject
Parameters
Type Name Description
String memberName
Returns
Type Description
Characteristic<T>
Type Parameters
Name Description
TOwner
T

Create<TOwner, T>(String, T)

Declaration
public static Characteristic<T> Create<TOwner, T>(string memberName, T fallbackValue)
    where TOwner : CharacteristicObject
Parameters
Type Name Description
String memberName
T fallbackValue
Returns
Type Description
Characteristic<T>
Type Parameters
Name Description
TOwner
T

Create<TOwner, T>(String, Func<CharacteristicObject, T, T>, T, Boolean)

Declaration
public static Characteristic<T> Create<TOwner, T>(string memberName, Func<CharacteristicObject, T, T> resolver, T fallbackValue, bool ignoreOnApply)
    where TOwner : CharacteristicObject
Parameters
Type Name Description
String memberName
Func<CharacteristicObject, T, T> resolver
T fallbackValue
Boolean ignoreOnApply
Returns
Type Description
Characteristic<T>
Type Parameters
Name Description
TOwner
T

CreateHidden<TOwner, T>(String)

Declaration
public static Characteristic<T> CreateHidden<TOwner, T>(string memberName)
    where TOwner : CharacteristicObject
Parameters
Type Name Description
String memberName
Returns
Type Description
Characteristic<T>
Type Parameters
Name Description
TOwner
T

CreateIgnoreOnApply<TOwner, T>(String)

Declaration
public static Characteristic<T> CreateIgnoreOnApply<TOwner, T>(string memberName)
    where TOwner : CharacteristicObject
Parameters
Type Name Description
String memberName
Returns
Type Description
Characteristic<T>
Type Parameters
Name Description
TOwner
T

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Extension Methods