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

#include <FileConstructorStatistics.h>

+ Inheritance diagram for BuildPatchServices::IFileConstructorStatistics:

Public Member Functions

virtual int64 GetRequiredConstructSize () const =0
 
virtual uint64 GetBytesConstructed () const =0
 
virtual uint64 GetFilesConstructed () const =0
 
virtual FGuid GetCurrentChunk () const =0
 
virtual FString GetCurrentFile () const =0
 
virtual float GetCurrentFileProgress () const =0
 
virtual bool IsCurrentlyWriting () const =0
 
virtual bool IsCurrentlyReading () const =0
 
virtual bool IsCurrentlyAdministering () const =0
 
- Public Member Functions inherited from BuildPatchServices::IFileConstructorStat
virtual ~IFileConstructorStat ()
 
virtual void OnResumeStarted ()=0
 
virtual void OnResumeCompleted ()=0
 
virtual void OnChunkGet (const FGuid &ChunkId)=0
 
virtual void OnFileStarted (const FString &Filename, int64 FileSize)=0
 
virtual void OnFileProgress (const FString &Filename, int64 TotalBytes)=0
 
virtual void OnFileCompleted (const FString &Filename, bool bSuccess)=0
 
virtual void OnConstructionCompleted ()=0
 
virtual void OnProcessedDataUpdated (int64 TotalBytes)=0
 
virtual void OnTotalRequiredUpdated (int64 TotalBytes)=0
 
virtual void OnBeforeAdminister ()=0
 
virtual void OnAfterAdminister (const ISpeedRecorder::FRecord &Record)=0
 
virtual void OnBeforeRead ()=0
 
virtual void OnAfterRead (const ISpeedRecorder::FRecord &Record)=0
 
virtual void OnBeforeWrite ()=0
 
virtual void OnAfterWrite (const ISpeedRecorder::FRecord &Record)=0
 

Detailed Description

Interface to the statistics class which provides access to tracked values from a file constructor stat.

Member Function Documentation

◆ GetBytesConstructed()

virtual uint64 BuildPatchServices::IFileConstructorStatistics::GetBytesConstructed ( ) const
pure virtual
Returns
the total number of bytes constructed.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ GetCurrentChunk()

virtual FGuid BuildPatchServices::IFileConstructorStatistics::GetCurrentChunk ( ) const
pure virtual
Returns
the current chunk data is being serialized from.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ GetCurrentFile()

virtual FString BuildPatchServices::IFileConstructorStatistics::GetCurrentFile ( ) const
pure virtual
Returns
the current file data is being serialized to.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ GetCurrentFileProgress()

virtual float BuildPatchServices::IFileConstructorStatistics::GetCurrentFileProgress ( ) const
pure virtual
Returns
the current file progress.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ GetFilesConstructed()

virtual uint64 BuildPatchServices::IFileConstructorStatistics::GetFilesConstructed ( ) const
pure virtual
Returns
the total number of files constructed.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ GetRequiredConstructSize()

virtual int64 BuildPatchServices::IFileConstructorStatistics::GetRequiredConstructSize ( ) const
pure virtual
Returns
the number of bytes to construct to complete the installation.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ IsCurrentlyAdministering()

virtual bool BuildPatchServices::IFileConstructorStatistics::IsCurrentlyAdministering ( ) const
pure virtual
Returns
true if currently administering files.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ IsCurrentlyReading()

virtual bool BuildPatchServices::IFileConstructorStatistics::IsCurrentlyReading ( ) const
pure virtual
Returns
true if currently reading disk data.

Implemented in BuildPatchServices::FFileConstructorStatistics.

◆ IsCurrentlyWriting()

virtual bool BuildPatchServices::IFileConstructorStatistics::IsCurrentlyWriting ( ) const
pure virtual
Returns
true if currently writing disk data.

Implemented in BuildPatchServices::FFileConstructorStatistics.


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