UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IAutomationLatentCommandWithRetriesAndDelays Class Referenceabstract

#include <AutomationTest.h>

+ Inheritance diagram for IAutomationLatentCommandWithRetriesAndDelays:

Public Member Functions

virtual ~IAutomationLatentCommandWithRetriesAndDelays ()
 
virtual void CommandFailedDueToError (const FString &ErrorMessage)
 
virtual bool Update () override
 
virtual bool Execute ()=0
 
- Public Member Functions inherited from IAutomationLatentCommand
virtual ~IAutomationLatentCommand ()
 
- Public Member Functions inherited from TSharedFromThis< IAutomationLatentCommand >
TSharedRef< IAutomationLatentCommand, Mode > AsShared ()
 
TSharedRef< IAutomationLatentCommand const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IAutomationLatentCommand, Mode > AsWeak ()
 
TWeakPtr< IAutomationLatentCommand const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

 IAutomationLatentCommandWithRetriesAndDelays ()
 
 IAutomationLatentCommandWithRetriesAndDelays (const FString InCommandClassName, const int32 InMaxRetries, const double InWaitTimeBetweenRuns)
 
void ResetDelayTimer ()
 
bool IsDelayTimerRunning () const
 
bool HasExceededMaxTotalRunTime ()
 
bool CanRetry () const
 
FString GetTestAndCommandName () const
 
FAutomationTestBase * GetCurrentTest () const
 
void OverrideMaxTotalRunTimeInSeconds (double OverrideValue)
 
- Protected Member Functions inherited from IAutomationLatentCommand
 IAutomationLatentCommand ()
 
double GetCurrentRunTime () const
 
- Protected Member Functions inherited from TSharedFromThis< IAutomationLatentCommand >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

const FString CommandClassName = "UnknownCommand"
 
const int32 MaxRetries = 10
 
const bool bHasUnlimitedRetries = false
 
const double DelayTimeInSeconds = 1.0
 
double DelayStartTime = 0.0
 
- Protected Attributes inherited from IAutomationLatentCommand
double StartTime
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< IAutomationLatentCommand >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~IAutomationLatentCommandWithRetriesAndDelays()

virtual IAutomationLatentCommandWithRetriesAndDelays::~IAutomationLatentCommandWithRetriesAndDelays ( )
inlinevirtual

◆ IAutomationLatentCommandWithRetriesAndDelays() [1/2]

IAutomationLatentCommandWithRetriesAndDelays::IAutomationLatentCommandWithRetriesAndDelays ( )
inlineprotected

◆ IAutomationLatentCommandWithRetriesAndDelays() [2/2]

IAutomationLatentCommandWithRetriesAndDelays::IAutomationLatentCommandWithRetriesAndDelays ( const FString  InCommandClassName,
const int32  InMaxRetries,
const double  InWaitTimeBetweenRuns 
)
inlineprotected

Member Function Documentation

◆ CanRetry()

bool IAutomationLatentCommandWithRetriesAndDelays::CanRetry ( ) const
inlineprotected

◆ CommandFailedDueToError()

virtual void IAutomationLatentCommandWithRetriesAndDelays::CommandFailedDueToError ( const FString &  ErrorMessage)
inlinevirtual

◆ Execute()

virtual bool IAutomationLatentCommandWithRetriesAndDelays::Execute ( )
pure virtual

◆ GetCurrentTest()

FAutomationTestBase * IAutomationLatentCommandWithRetriesAndDelays::GetCurrentTest ( ) const
inlineprotected

◆ GetTestAndCommandName()

FString IAutomationLatentCommandWithRetriesAndDelays::GetTestAndCommandName ( ) const
inlineprotected

◆ HasExceededMaxTotalRunTime()

bool IAutomationLatentCommandWithRetriesAndDelays::HasExceededMaxTotalRunTime ( )
inlineprotected

◆ IsDelayTimerRunning()

bool IAutomationLatentCommandWithRetriesAndDelays::IsDelayTimerRunning ( ) const
inlineprotected

◆ OverrideMaxTotalRunTimeInSeconds()

void IAutomationLatentCommandWithRetriesAndDelays::OverrideMaxTotalRunTimeInSeconds ( double  OverrideValue)
inlineprotected

◆ ResetDelayTimer()

void IAutomationLatentCommandWithRetriesAndDelays::ResetDelayTimer ( )
inlineprotected

◆ Update()

virtual bool IAutomationLatentCommandWithRetriesAndDelays::Update ( )
inlineoverridevirtual

Updates the current command and will only return TRUE when it has fulfilled its role (Load map has completed and wait time has expired)

Implements IAutomationLatentCommand.

Member Data Documentation

◆ bHasUnlimitedRetries

const bool IAutomationLatentCommandWithRetriesAndDelays::bHasUnlimitedRetries = false
protected

◆ CommandClassName

const FString IAutomationLatentCommandWithRetriesAndDelays::CommandClassName = "UnknownCommand"
protected

◆ DelayStartTime

double IAutomationLatentCommandWithRetriesAndDelays::DelayStartTime = 0.0
protected

◆ DelayTimeInSeconds

const double IAutomationLatentCommandWithRetriesAndDelays::DelayTimeInSeconds = 1.0
protected

◆ MaxRetries

const int32 IAutomationLatentCommandWithRetriesAndDelays::MaxRetries = 10
protected
The documentation for this class was generated from the following file: