Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
IAutomationLatentCommandWithRetriesAndDelays Class Referenceabstract

#include <AutomationTest.h>

+ Inheritance diagram for IAutomationLatentCommandWithRetriesAndDelays:
+ Collaboration 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
 
TWeakPtr< IAutomationLatentCommand, Mode > AsWeak ()
 
TWeakPtr< IAutomationLatentCommand const, Mode > AsWeak () const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, Mode > const *InSharedPtr, OtherType *InObject) const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, Mode > const *InSharedRef, OtherType *InObject) const
 
FORCEINLINE 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 &)
 
FORCEINLINE 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
 

Private Attributes

int32 CurrentIteration = 0
 
double MaxTotalRunTimeInSeconds = 300.0
 

Additional Inherited Members

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

Detailed Description

Definition at line 3711 of file AutomationTest.h.

Constructor & Destructor Documentation

◆ ~IAutomationLatentCommandWithRetriesAndDelays()

virtual IAutomationLatentCommandWithRetriesAndDelays::~IAutomationLatentCommandWithRetriesAndDelays ( )
inlinevirtual

Definition at line 3714 of file AutomationTest.h.

◆ IAutomationLatentCommandWithRetriesAndDelays() [1/2]

IAutomationLatentCommandWithRetriesAndDelays::IAutomationLatentCommandWithRetriesAndDelays ( )
inlineprotected

Definition at line 3794 of file AutomationTest.h.

◆ IAutomationLatentCommandWithRetriesAndDelays() [2/2]

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

Definition at line 3797 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ CanRetry()

bool IAutomationLatentCommandWithRetriesAndDelays::CanRetry ( ) const
inlineprotected

Definition at line 3836 of file AutomationTest.h.

+ Here is the caller graph for this function:

◆ CommandFailedDueToError()

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

Definition at line 3716 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Execute()

virtual bool IAutomationLatentCommandWithRetriesAndDelays::Execute ( )
pure virtual
+ Here is the caller graph for this function:

◆ GetCurrentTest()

FAutomationTestBase * IAutomationLatentCommandWithRetriesAndDelays::GetCurrentTest ( ) const
inlineprotected

Definition at line 3848 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTestAndCommandName()

FString IAutomationLatentCommandWithRetriesAndDelays::GetTestAndCommandName ( ) const
inlineprotected

Definition at line 3842 of file AutomationTest.h.

+ Here is the caller graph for this function:

◆ HasExceededMaxTotalRunTime()

bool IAutomationLatentCommandWithRetriesAndDelays::HasExceededMaxTotalRunTime ( )
inlineprotected

Definition at line 3829 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsDelayTimerRunning()

bool IAutomationLatentCommandWithRetriesAndDelays::IsDelayTimerRunning ( ) const
inlineprotected

Definition at line 3822 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ OverrideMaxTotalRunTimeInSeconds()

void IAutomationLatentCommandWithRetriesAndDelays::OverrideMaxTotalRunTimeInSeconds ( double OverrideValue)
inlineprotected

Definition at line 3853 of file AutomationTest.h.

◆ ResetDelayTimer()

void IAutomationLatentCommandWithRetriesAndDelays::ResetDelayTimer ( )
inlineprotected

Definition at line 3816 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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.

Definition at line 3727 of file AutomationTest.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ bHasUnlimitedRetries

const bool IAutomationLatentCommandWithRetriesAndDelays::bHasUnlimitedRetries = false
protected

Definition at line 3867 of file AutomationTest.h.

◆ CommandClassName

const FString IAutomationLatentCommandWithRetriesAndDelays::CommandClassName = "UnknownCommand"
protected

Definition at line 3859 of file AutomationTest.h.

◆ CurrentIteration

int32 IAutomationLatentCommandWithRetriesAndDelays::CurrentIteration = 0
private

Definition at line 3790 of file AutomationTest.h.

◆ DelayStartTime

double IAutomationLatentCommandWithRetriesAndDelays::DelayStartTime = 0.0
protected

Definition at line 3874 of file AutomationTest.h.

◆ DelayTimeInSeconds

const double IAutomationLatentCommandWithRetriesAndDelays::DelayTimeInSeconds = 1.0
protected

Definition at line 3871 of file AutomationTest.h.

◆ MaxRetries

const int32 IAutomationLatentCommandWithRetriesAndDelays::MaxRetries = 10
protected

Definition at line 3863 of file AutomationTest.h.

◆ MaxTotalRunTimeInSeconds

double IAutomationLatentCommandWithRetriesAndDelays::MaxTotalRunTimeInSeconds = 300.0
private

Definition at line 3879 of file AutomationTest.h.

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