UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
InstallBundleUtil::PersistentStats::FSessionPersistentStats Class Reference

#include <InstallBundleUtils.h>

+ Inheritance diagram for InstallBundleUtil::PersistentStats::FSessionPersistentStats:

Public Member Functions

INSTALLBUNDLEMANAGER_API BEGIN_JSON_SERIALIZER JSON_SERIALIZE ("SessionName", SessionName)
 
 JSON_SERIALIZE_ARRAY ("RequiredBundles", RequiredBundles)
 
 JSON_SERIALIZE ("AnalyticsSessionID", AnalyticsSessionID)
 
 JSON_SERIALIZE_MAP ("CountStats", CountStatMap)
 
 JSON_SERIALIZE_MAP_SERIALIZABLE ("TimingStats", TimingStatsMap, FPersistentTimerData)
 
 FSessionPersistentStats (const FString &ContentRequestNameIn)
 
virtual ~FSessionPersistentStats ()
 
INSTALLBUNDLEMANAGER_API void AddRequiredBundles (const TArray< FString > &RequiredBundlesToAdd)
 
INSTALLBUNDLEMANAGER_API void AddRequiredBundles (const TArray< FName > &RequiredBundlesToAdd)
 
INSTALLBUNDLEMANAGER_API void ResetRequiredBundles (const TArray< FString > &NewRequiredBundles=TArray< FString >())
 
INSTALLBUNDLEMANAGER_API void GetRequiredBundles (TArray< FString > &OutRequiredBundles) const
 
virtual INSTALLBUNDLEMANAGER_API const FString GetFullPathForStatFile () const override
 
- Public Member Functions inherited from InstallBundleUtil::PersistentStats::FPersistentStatsBase
INSTALLBUNDLEMANAGER_API BEGIN_JSON_SERIALIZER JSON_SERIALIZE ("AnalyticsSessionID", AnalyticsSessionID)
 
 JSON_SERIALIZE_MAP ("CountStats", CountStatMap)
 
 JSON_SERIALIZE_MAP_SERIALIZABLE ("TimingStats", TimingStatsMap, FPersistentTimerData)
 
virtual ~FPersistentStatsBase ()
 
INSTALLBUNDLEMANAGER_API void StatsBegin (const FString &ExpectedAnalyticsID, bool bForceResetData=false)
 
INSTALLBUNDLEMANAGER_API void StatsEnd (bool bStopAllActiveTimers=true)
 
INSTALLBUNDLEMANAGER_API bool IsTimingStatStarted (ETimingStatNames StatToUpdate) const
 
INSTALLBUNDLEMANAGER_API void StartTimingStat (ETimingStatNames StatToUpdate)
 
INSTALLBUNDLEMANAGER_API void StopTimingStat (ETimingStatNames StatToUpdate, bool UpdateTimerOnStop=true)
 
INSTALLBUNDLEMANAGER_API void UpdateTimingStat (ETimingStatNames StatToUpdate)
 
INSTALLBUNDLEMANAGER_API void UpdateAllActiveTimers ()
 
INSTALLBUNDLEMANAGER_API void StopAllActiveTimers ()
 
bool IsActive () const
 
bool IsDirty () const
 
INSTALLBUNDLEMANAGER_API void IncrementCountStat (PersistentStats::ECountStatNames StatToUpdate)
 
INSTALLBUNDLEMANAGER_API bool HasTimingStat (ETimingStatNames StatToCheck) const
 
INSTALLBUNDLEMANAGER_API bool HasCountStat (ECountStatNames StatToCheck) const
 
INSTALLBUNDLEMANAGER_API const FPersistentTimerDataGetTimingStatData (ETimingStatNames StatToGet) const
 
INSTALLBUNDLEMANAGER_API const int * GetCountStatData (ECountStatNames StatToGet) const
 
INSTALLBUNDLEMANAGER_API bool SaveStatsToDisk ()
 
INSTALLBUNDLEMANAGER_API bool LoadStatsFromDisk ()
 
- Public Member Functions inherited from FJsonSerializable
virtual JSON_API ~FJsonSerializable ()
 
JSON_API const FString ToJson (bool bPrettyPrint=true) const
 
JSON_API const FUtf8String ToJsonUtf8 (bool bPrettyPrint=true) const
 
virtual JSON_API const FString ToJson (bool bPrettyPrint=true)
 
virtual JSON_API const FUtf8String ToJsonUtf8 (bool bPrettyPrint=true)
 
template<class CharType , class PrintPolicy , ESPMode SPMode>
void ToJson (TSharedRef< TJsonWriter< CharType, PrintPolicy >, SPMode > JsonWriter, bool bFlatObject=false) const
 
virtual JSON_API bool FromJson (const TCHAR *Json)
 
virtual JSON_API bool FromJson (const UTF8CHAR *Json)
 
virtual JSON_API bool FromJson (const FString &Json)
 
virtual JSON_API bool FromJson (const FUtf8String &Json)
 
virtual JSON_API bool FromJson (FString &&Json)
 
virtual JSON_API bool FromJson (FUtf8String &&Json)
 
JSON_API bool FromJsonStringView (FUtf8StringView JsonStringView)
 
JSON_API bool FromJsonStringView (FWideStringView JsonStringView)
 
virtual JSON_API bool FromJson (TSharedPtr< FJsonObject > JsonObject)
 
virtual void Serialize (FJsonSerializerBase &Serializer, bool bFlatObject)=0
 

Additional Inherited Members

- Static Public Member Functions inherited from InstallBundleUtil::PersistentStats::FPersistentStatsBase
static INSTALLBUNDLEMANAGER_API const FString GetBaseExpectedAnalyticsID ()
 
- Protected Member Functions inherited from InstallBundleUtil::PersistentStats::FPersistentStatsBase
INSTALLBUNDLEMANAGER_API void ResetStats (const FString &NewAnalyticsSessionID)
 
INSTALLBUNDLEMANAGER_API void OnLoadingDataFromDisk ()
 
INSTALLBUNDLEMANAGER_API void HandleTimerStatsAfterDataLoad ()
 
 FPersistentStatsBase ()
 
- Protected Attributes inherited from InstallBundleUtil::PersistentStats::FPersistentStatsBase
TMap< FString, FPersistentTimerDataTimingStatsMap
 
TMap< FString, int > CountStatMap
 
FString AnalyticsSessionID
 
bool bIsActive
 
bool bIsDirty
 
bool bHasLoadedFromDisk
 

Constructor & Destructor Documentation

◆ FSessionPersistentStats()

InstallBundleUtil::PersistentStats::FSessionPersistentStats::FSessionPersistentStats ( const FString &  ContentRequestNameIn)
inline

◆ ~FSessionPersistentStats()

virtual InstallBundleUtil::PersistentStats::FSessionPersistentStats::~FSessionPersistentStats ( )
inlinevirtual

Member Function Documentation

◆ AddRequiredBundles() [1/2]

void InstallBundleUtil::PersistentStats::FSessionPersistentStats::AddRequiredBundles ( const TArray< FName > &  RequiredBundlesToAdd)

◆ AddRequiredBundles() [2/2]

void InstallBundleUtil::PersistentStats::FSessionPersistentStats::AddRequiredBundles ( const TArray< FString > &  RequiredBundlesToAdd)

◆ GetFullPathForStatFile()

const FString InstallBundleUtil::PersistentStats::FSessionPersistentStats::GetFullPathForStatFile ( ) const
overridevirtual

◆ GetRequiredBundles()

void InstallBundleUtil::PersistentStats::FSessionPersistentStats::GetRequiredBundles ( TArray< FString > &  OutRequiredBundles) const

◆ JSON_SERIALIZE() [1/2]

InstallBundleUtil::PersistentStats::FSessionPersistentStats::JSON_SERIALIZE ( "AnalyticsSessionID"  ,
AnalyticsSessionID   
)

◆ JSON_SERIALIZE() [2/2]

INSTALLBUNDLEMANAGER_API BEGIN_JSON_SERIALIZER InstallBundleUtil::PersistentStats::FSessionPersistentStats::JSON_SERIALIZE ( "SessionName"  ,
SessionName   
)

◆ JSON_SERIALIZE_ARRAY()

InstallBundleUtil::PersistentStats::FSessionPersistentStats::JSON_SERIALIZE_ARRAY ( "RequiredBundles"  ,
RequiredBundles   
)

◆ JSON_SERIALIZE_MAP()

InstallBundleUtil::PersistentStats::FSessionPersistentStats::JSON_SERIALIZE_MAP ( "CountStats"  ,
CountStatMap   
)

◆ JSON_SERIALIZE_MAP_SERIALIZABLE()

InstallBundleUtil::PersistentStats::FSessionPersistentStats::JSON_SERIALIZE_MAP_SERIALIZABLE ( "TimingStats"  ,
TimingStatsMap  ,
FPersistentTimerData   
)

◆ ResetRequiredBundles()

void InstallBundleUtil::PersistentStats::FSessionPersistentStats::ResetRequiredBundles ( const TArray< FString > &  NewRequiredBundles = TArray<FString>())

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