Navigation
API > API/Runtime > API/Runtime/NetCore
Base class for tracking the minimum, maximum and average of the passed in measurement values.
This base class can handle reading. The TSampleMinMaxAvg subclass is compatible as a consumer for TSampleProducer, and is used for writing.
| Name | FSampleMinMaxAvg |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Core/Public/Net/Core/Analytics/NetStatsUtils.h |
| Include Path | #include "Net/Core/Analytics/NetStatsUtils.h" |
Syntax
class FSampleMinMaxAvg
Derived Classes
- TSampleMinMaxAvg< EMinMaxValueMode::PerMeasurement >
- TSampleMinMaxAvg< EMinMaxValueMode::PerSample >
- TSampleMinMaxAvg< EMinMaxValueMode::PerTimeSeconds, MinMaxTimeSeconds >
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentValue | double | The current sample value | Net/Core/Analytics/NetStatsUtils.h | |
| MaxValue | double | The maximum sample value encountered | Net/Core/Analytics/NetStatsUtils.h | |
| MinValue | double | The minimum sample value encountered | Net/Core/Analytics/NetStatsUtils.h | |
| TotalCount | int32 | The number of samples tracked | Net/Core/Analytics/NetStatsUtils.h | |
| TotalSum | double | The total sum of all samples | Net/Core/Analytics/NetStatsUtils.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
double GetAvg() |
Gets the average sample value | Net/Core/Analytics/NetStatsUtils.h | |
double GetCurrent() |
Gets the current/latest sample value | Net/Core/Analytics/NetStatsUtils.h | |
double GetMax() |
Gets the maximum sample value encountered | Net/Core/Analytics/NetStatsUtils.h | |
double GetMin() |
Gets the minimum sample value encountered | Net/Core/Analytics/NetStatsUtils.h | |
int32 GetSampleCount() |
Gets the number of samples tracked | Net/Core/Analytics/NetStatsUtils.h | |
double GetSum() |
Gets the sum of all sample values tracked | Net/Core/Analytics/NetStatsUtils.h | |
void Reset() |
Resets the accumulated sample data | Net/Core/Analytics/NetStatsUtils.h |