BuildPatchServices::FBuildPatchProgress Struct Reference

#include <BuildPatchProgress.h>

Inheritance diagram for BuildPatchServices::FBuildPatchProgress:

Public Member Functions
	FBuildPatchProgress ()
virtual void	SetPaused (bool bIsPaused) override
virtual void	Abort () override
virtual void	SetStateProgress (const EBuildPatchState &State, const float &Value)
virtual void	SetStateWeight (const EBuildPatchState &State, const float &Value)
virtual EBuildPatchState	GetState () const
virtual float	GetProgress () const
virtual float	GetProgressNoMarquee () const
virtual float	GetStateProgress (const EBuildPatchState &State) const
virtual float	GetStateWeight (const EBuildPatchState &State) const
virtual bool	TogglePauseState ()
virtual double	WaitWhilePaused () const
virtual bool	GetPauseState () const
virtual void	SetIsDownloading (bool bIsDownloading)
virtual void	CancelAbort ()
Public Member Functions inherited from BuildPatchServices::IControllable
virtual	~IControllable ()

Detailed Description

A struct to hold patch progress tracking

Constructor & Destructor Documentation

FBuildPatchProgress()

BuildPatchServices::FBuildPatchProgress::FBuildPatchProgress

(

)

Default constructor

Member Function Documentation

Abort()

void BuildPatchServices::FBuildPatchProgress::Abort ( )

overridevirtual

Called to instruct the class to cease all activity, and perform any shutdown.

Implements BuildPatchServices::IControllable.

CancelAbort()

void BuildPatchServices::FBuildPatchProgress::CancelAbort ( )

virtual

Resets an abort state, for the next installer iteration.

GetPauseState()

bool BuildPatchServices::FBuildPatchProgress::GetPauseState ( ) const

virtual

Gets the pause state

Returns

Whether the current state is paused

GetProgress()

float BuildPatchServices::FBuildPatchProgress::GetProgress ( ) const

virtual

Gets the current overall progress

Returns

The current progress value. Range 0 to 1. -1 indicates undetermined, i.e. show a marquee style bar.

GetProgressNoMarquee()

float BuildPatchServices::FBuildPatchProgress::GetProgressNoMarquee ( ) const

virtual

Gets the current overall progress regardless of current state using marquee

Returns

The current progress value. Range 0 to 1.

GetState()

EBuildPatchState BuildPatchServices::FBuildPatchProgress::GetState ( ) const

virtual

Gets the current progress state

Returns

The current progress state

GetStateProgress()

float BuildPatchServices::FBuildPatchProgress::GetStateProgress ( const EBuildPatchState &  State ) const

virtual

Gets the progress value for a particular state

Parameters

State

The state to get progress for

Returns

The state progress value. Range 0 to 1.

GetStateWeight()

float BuildPatchServices::FBuildPatchProgress::GetStateWeight ( const EBuildPatchState &  State ) const

virtual

Gets the weight value for a particular state

Parameters

State

The state to get weight for

Returns

The state weight value.

SetIsDownloading()

void BuildPatchServices::FBuildPatchProgress::SetIsDownloading ( bool  bIsDownloading )

virtual

Set the set state of whether the system is currently downloading data.

Parameters

bIsDownloading

Whether the system is currently downloading data.

SetPaused()

void BuildPatchServices::FBuildPatchProgress::SetPaused ( bool  bIsPaused )

overridevirtual

Sets whether the class should pause current activities and wait.

Parameters

bIsPaused

True if the class should pause.

Implements BuildPatchServices::IControllable.

SetStateProgress()

void BuildPatchServices::FBuildPatchProgress::SetStateProgress ( const EBuildPatchState &  State, const float &  Value  )

virtual

Sets the progress value for a particular state

Parameters

State	The state to set progress for
Value	The progress value

SetStateWeight()

void BuildPatchServices::FBuildPatchProgress::SetStateWeight ( const EBuildPatchState &  State, const float &  Value  )

virtual

Sets the progress weight for a particular state

Parameters

State	The state to set weight for
Value	The weight value

TogglePauseState()

bool BuildPatchServices::FBuildPatchProgress::TogglePauseState ( )

virtual

Toggles the pause state

Returns

Whether the current state is now paused

WaitWhilePaused()

double BuildPatchServices::FBuildPatchProgress::WaitWhilePaused ( ) const

virtual

Blocks calling thread while the progress is paused

Returns

How long we paused for, in seconds

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchProgress.h
• Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchProgress.cpp