UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BuildPatchServices::FBuildStatistics Class Reference
+ Inheritance diagram for BuildPatchServices::FBuildStatistics:

Public Member Functions

 FBuildStatistics (FBuildPatchInstallerRef Installer)
 
 ~FBuildStatistics ()
 
virtual const FBuildInstallerConfigurationGetConfiguration () const override
 
virtual int64 GetDownloadSize () const override
 
virtual int64 GetBuildSize () const override
 
virtual FString GetCurrentWorkingFileName () const override
 
virtual float GetCurrentWorkingFileProgress () const override
 
virtual FGuid GetCurrentWorkingData () const override
 
virtual TArray< FDownloadGetCurrentDownloads () const override
 
virtual bool IsDownloadActive () const override
 
virtual bool IsHardDiskActiveAdministering () const override
 
virtual bool IsHardDiskActiveWrite () const override
 
virtual bool IsHardDiskActiveRead () const override
 
virtual const TArray< FFileOperation > & GetFileOperationStates () const override
 
virtual double GetDownloadByteSpeed () const override
 
virtual double GetDiskReadByteSpeed () const override
 
virtual double GetDiskWriteByteSpeed () const override
 
virtual int32 GetNumVerifyErrors () const override
 
virtual TMap< EVerifyError, int32GetVerifyErrorCounts () const override
 
- Public Member Functions inherited from BuildPatchServices::IBuildStatistics
virtual ~IBuildStatistics ()
 
virtual int32 GetMemoryChunkStoreSize () const
 
virtual int32 GetMemoryChunksInStore () const
 
virtual int32 GetMemoryChunksBooted () const
 
virtual int32 GetMemoryChunksRetained () const
 
double GetChunkDbReadByteSpeed () const
 

Constructor & Destructor Documentation

◆ FBuildStatistics()

BuildPatchServices::FBuildStatistics::FBuildStatistics ( FBuildPatchInstallerRef  Installer)

◆ ~FBuildStatistics()

BuildPatchServices::FBuildStatistics::~FBuildStatistics ( )
inline

Member Function Documentation

◆ GetBuildSize()

int64 BuildPatchServices::FBuildStatistics::GetBuildSize ( ) const
overridevirtual
Returns
the total install size for the installation.

Implements BuildPatchServices::IBuildStatistics.

◆ GetConfiguration()

const FBuildInstallerConfiguration & BuildPatchServices::FBuildStatistics::GetConfiguration ( ) const
overridevirtual
Returns
the configuration used when constructing the installer.

Implements BuildPatchServices::IBuildStatistics.

◆ GetCurrentDownloads()

TArray< FDownload > BuildPatchServices::FBuildStatistics::GetCurrentDownloads ( ) const
overridevirtual
Returns
an array of currently active downloads.

Implements BuildPatchServices::IBuildStatistics.

◆ GetCurrentWorkingData()

FGuid BuildPatchServices::FBuildStatistics::GetCurrentWorkingData ( ) const
overridevirtual
Returns
the chunk ID currently being used to write the current file.

Implements BuildPatchServices::IBuildStatistics.

◆ GetCurrentWorkingFileName()

FString BuildPatchServices::FBuildStatistics::GetCurrentWorkingFileName ( ) const
overridevirtual
Returns
the filename of the file currently being worked on.

Implements BuildPatchServices::IBuildStatistics.

◆ GetCurrentWorkingFileProgress()

float BuildPatchServices::FBuildStatistics::GetCurrentWorkingFileProgress ( ) const
overridevirtual
Returns
the progress of the file currently being worked on.

Implements BuildPatchServices::IBuildStatistics.

◆ GetDiskReadByteSpeed()

double BuildPatchServices::FBuildStatistics::GetDiskReadByteSpeed ( ) const
overridevirtual
Returns
the current disk read speed in bytes per second.

Implements BuildPatchServices::IBuildStatistics.

◆ GetDiskWriteByteSpeed()

double BuildPatchServices::FBuildStatistics::GetDiskWriteByteSpeed ( ) const
overridevirtual
Returns
the current disk write speed in bytes per second.

Implements BuildPatchServices::IBuildStatistics.

◆ GetDownloadByteSpeed()

double BuildPatchServices::FBuildStatistics::GetDownloadByteSpeed ( ) const
overridevirtual
Returns
the current download speed in bytes per second.

Implements BuildPatchServices::IBuildStatistics.

◆ GetDownloadSize()

int64 BuildPatchServices::FBuildStatistics::GetDownloadSize ( ) const
overridevirtual
Returns
the total download size for the installation.

Implements BuildPatchServices::IBuildStatistics.

◆ GetFileOperationStates()

const TArray< FFileOperation > & BuildPatchServices::FBuildStatistics::GetFileOperationStates ( ) const
overridevirtual
Returns
an array containing the states for all file write operations being performed by this installation.

Implements BuildPatchServices::IBuildStatistics.

◆ GetNumVerifyErrors()

int32 BuildPatchServices::FBuildStatistics::GetNumVerifyErrors ( ) const
overridevirtual
Returns
the total number of verify errors experienced during this installation.

Implements BuildPatchServices::IBuildStatistics.

◆ GetVerifyErrorCounts()

TMap< EVerifyError, int32 > BuildPatchServices::FBuildStatistics::GetVerifyErrorCounts ( ) const
overridevirtual
Returns
the verify error counts per error type experienced during this installation.

Implements BuildPatchServices::IBuildStatistics.

◆ IsDownloadActive()

bool BuildPatchServices::FBuildStatistics::IsDownloadActive ( ) const
overridevirtual
Returns
true if there are downloads currently active.

Implements BuildPatchServices::IBuildStatistics.

◆ IsHardDiskActiveAdministering()

bool BuildPatchServices::FBuildStatistics::IsHardDiskActiveAdministering ( ) const
overridevirtual
Returns
true if the current operation is creating or opening files.

Implements BuildPatchServices::IBuildStatistics.

◆ IsHardDiskActiveRead()

bool BuildPatchServices::FBuildStatistics::IsHardDiskActiveRead ( ) const
overridevirtual
Returns
true if currently reading data from disk.

Implements BuildPatchServices::IBuildStatistics.

◆ IsHardDiskActiveWrite()

bool BuildPatchServices::FBuildStatistics::IsHardDiskActiveWrite ( ) const
overridevirtual
Returns
true if currently writing data to disk.

Implements BuildPatchServices::IBuildStatistics.


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