Class SampleGroup
Represents a group of samples for a performance test that share a common name and unit.
Implements
Inherited Members
Namespace: Unity.PerformanceTesting.Data
Assembly: Unity.PerformanceTesting.dll
Syntax
[Serializable]
public class SampleGroup : IDeserializationCallback
Constructors
SampleGroup()
Creates a sample group without initializing values.
Declaration
public SampleGroup()
SampleGroup(string, SampleUnit, bool)
Creates a sample group with provided arguments.
Declaration
public SampleGroup(string name, SampleUnit unit, bool increaseIsBetter)
Parameters
Type | Name | Description |
---|---|---|
string | name | Sample group name. |
SampleUnit | unit | Measurement unit. |
bool | increaseIsBetter | Whether the measurement is inverted and increase is positive. |
Exceptions
Type | Condition |
---|---|
PerformanceTestException | Exception thrown when invalid name is used. |
Fields
Average
Average value of samples.
Declaration
public double Average
Field Value
Type | Description |
---|---|
double |
IncreaseIsBetter
Whether the measurement is inverted and increase is positive.
Declaration
public bool IncreaseIsBetter
Field Value
Type | Description |
---|---|
bool |
Max
Maximum value of samples.
Declaration
public double Max
Field Value
Type | Description |
---|---|
double |
Median
Median value of samples.
Declaration
public double Median
Field Value
Type | Description |
---|---|
double |
Min
Minimum value of samples.
Declaration
public double Min
Field Value
Type | Description |
---|---|
double |
Name
Name of the sample group.
Declaration
public string Name
Field Value
Type | Description |
---|---|
string |
Samples
List of samples.
Declaration
public List<double> Samples
Field Value
Type | Description |
---|---|
List<double> |
StandardDeviation
Standard deviation of samples.
Declaration
public double StandardDeviation
Field Value
Type | Description |
---|---|
double |
Sum
Sum of samples.
Declaration
public double Sum
Field Value
Type | Description |
---|---|
double |
Unit
Measurement unit.
Declaration
public SampleUnit Unit
Field Value
Type | Description |
---|---|
SampleUnit |
Methods
OnDeserialization(object)
Validates the deserialized object.
Declaration
public void OnDeserialization(object sender)
Parameters
Type | Name | Description |
---|---|---|
object | sender | The object that initiated the deserialization process. |