UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Protected Member Functions | List of all members
UE::Net::FBinnedMovingValueBase Class Reference

#include <NetStatsUtils.h>

+ Inheritance diagram for UE::Net::FBinnedMovingValueBase:

Classes

struct  FBin
 

Public Member Functions

NETCORE_API double GetSample () const
 
NETCORE_API void Reset ()
 

Protected Member Functions

 FBinnedMovingValueBase ()=delete
 
NETCORE_API FBinnedMovingValueBase (const TArrayView< FBin > InBins, double InTimePerBin, EBinnedValueMode InMode)
 
NETCORE_API void AddMeasurement_Implementation (double TimeVal, double Value, TOptional< double > &OutSample)
 

Detailed Description

Base class for moving values, implementing non-templatized data-structure/methods. See TBinnedMovingValue.

Constructor & Destructor Documentation

◆ FBinnedMovingValueBase() [1/2]

UE::Net::FBinnedMovingValueBase::FBinnedMovingValueBase ( )
protecteddelete

◆ FBinnedMovingValueBase() [2/2]

UE::Net::FBinnedMovingValueBase::FBinnedMovingValueBase ( const TArrayView< FBin >  InBins,
double  InTimePerBin,
EBinnedValueMode  InMode 
)
explicitprotected

FBinnedMovingValueBase

Member Function Documentation

◆ AddMeasurement_Implementation()

void UE::Net::FBinnedMovingValueBase::AddMeasurement_Implementation ( double  TimeVal,
double  Value,
TOptional< double > &  OutSample 
)
protected

Internal implementation for AddMeasurement, which outputs a sample if the bins have filled and rolled back over to FirstBinIndex.

Parameters
TimeValThe time value associated with the measurement, for time-based binning
ValueThe measurement value
OutSampleOutputs a sample, if all bins have filled and rolled back over to FirstBinIndex

◆ GetSample()

double UE::Net::FBinnedMovingValueBase::GetSample ( ) const

Gets a sample of the calculated moving value, based on current bin data.

Returns
Outputs the calculated sample value

◆ Reset()

void UE::Net::FBinnedMovingValueBase::Reset ( )

Resets the accumulated bin/sample data.

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