UE::Net::TBinnedDeltaMovingValue< ConsumerType, NumBins, InMode > Class Template Reference

#include <NetStatsUtils.h>

Inheritance diagram for UE::Net::TBinnedDeltaMovingValue< ConsumerType, NumBins, InMode >:

Public Member Functions
void	AddMeasurement (double TimeVal, double Value)
void	Reset ()
void	Flush ()

Detailed Description

template<typename ConsumerType, int32 NumBins, EBinnedValueMode InMode>
class UE::Net::TBinnedDeltaMovingValue< ConsumerType, NumBins, InMode >

Version of TBinnedMovingValue which takes permanently incrementing values (e.g. frame count), and uses the delta since the previous value as the measurement (this means the very first value is not measured).

Use TDeltaBinnedMovingAvg/TDeltaBinnedMovingSum aliases, instead of using this directly.

Parameters

ConsumerType	The type which will be used for consuming samples.
NumBins	The number of bins to use.
InMode	Internal

Member Function Documentation

AddMeasurement()

template<typename ConsumerType , int32 NumBins, EBinnedValueMode InMode>

void UE::Net::TBinnedDeltaMovingValue< ConsumerType, NumBins, InMode >::AddMeasurement ( double  TimeVal, double  Value  )

inline

Inputs a value whose delta is calculated for measurement, and the approximate time it was measured.

Parameters

TimeVal	The time of the measurement.
Value	The value to calculate the delta of, for measurement

Flush()

template<typename ConsumerType , int32 NumBins, EBinnedValueMode InMode>

void UE::Net::TBinnedMovingValue< ConsumerType, NumBins, InMode >::Flush ( )

inline

Flushes a sample from the current bin values to the consumer.

Since this is a moving value, none of the bins are reset when a sample is output (so the flushed sample can partially reflect old values), and the current bin will have been reset recently so it can be filled (so the flushed value may not reflect the full time period).

The user must consider whether this is accurate/suitable for their use case.

Reset()

template<typename ConsumerType , int32 NumBins, EBinnedValueMode InMode>

void UE::Net::TBinnedDeltaMovingValue< ConsumerType, NumBins, InMode >::Reset ( )

inline

Resets the accumulated bin/sample data (the very first value after this is not measured).

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Analytics/NetStatsUtils.h