UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::IMemoryChunkStoreStatistics Class Referenceabstract

#include <MemoryChunkStoreStatistics.h>

+ Inheritance diagram for BuildPatchServices::IMemoryChunkStoreStatistics:

Public Member Functions

virtual int32 GetStoreUse () const =0
 
virtual int32 GetStoreRetained () const =0
 
virtual int32 GetNumBooted () const =0
 
virtual int32 GetStoreSize () const =0
 
virtual float GetAverageStoreUse () const =0
 
virtual int32 GetPeakStoreUse () const =0
 
virtual float GetAverageStoreRetained () const =0
 
virtual int32 GetPeakStoreRetained () const =0
 
virtual void SetMultipleReferencedChunk (TSet< FGuid > MultipleReferencedChunks)=0
 
- Public Member Functions inherited from BuildPatchServices::IMemoryChunkStoreStat
virtual ~IMemoryChunkStoreStat ()
 
virtual void OnChunkStored (const FGuid &ChunkId)=0
 
virtual void OnChunkReleased (const FGuid &ChunkId)=0
 
virtual void OnChunkBooted (const FGuid &ChunkId)=0
 
virtual void OnStoreUseUpdated (int32 ChunkCount)=0
 
virtual void OnStoreSizeUpdated (int32 Size)=0
 

Detailed Description

Interface to the statistics class which provides access to tracked values from a memory chunk store stat.

Member Function Documentation

◆ GetAverageStoreRetained()

virtual float BuildPatchServices::IMemoryChunkStoreStatistics::GetAverageStoreRetained ( ) const
pure virtual
Returns
the average number of chunks held which are retained due to multiple references.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetAverageStoreUse()

virtual float BuildPatchServices::IMemoryChunkStoreStatistics::GetAverageStoreUse ( ) const
pure virtual
Returns
the average number of chunks held.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetNumBooted()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetNumBooted ( ) const
pure virtual
Returns
the number of chunks which have been booted.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetPeakStoreRetained()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetPeakStoreRetained ( ) const
pure virtual
Returns
the peak number of chunks held which are retained due to multiple references.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetPeakStoreUse()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetPeakStoreUse ( ) const
pure virtual
Returns
the peak number of chunks held.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetStoreRetained()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetStoreRetained ( ) const
pure virtual
Returns
the number of chunks held which are retained due to multiple references.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetStoreSize()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetStoreSize ( ) const
pure virtual
Returns
the maximum number of chunks which can be held.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ GetStoreUse()

virtual int32 BuildPatchServices::IMemoryChunkStoreStatistics::GetStoreUse ( ) const
pure virtual
Returns
the number of chunks held.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.

◆ SetMultipleReferencedChunk()

virtual void BuildPatchServices::IMemoryChunkStoreStatistics::SetMultipleReferencedChunk ( TSet< FGuid MultipleReferencedChunks)
pure virtual

Sets the chunks that are referenced multiple times in order to track retained.

Parameters
MultipleReferencedChunksFor retained stats, the set of chunks which have multiple references.

Implemented in BuildPatchServices::FMemoryChunkStoreStatistics.


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