Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FAutomationTestFramework::FAutomationTestMessageFilter Class Reference
+ Inheritance diagram for FAutomationTestFramework::FAutomationTestMessageFilter:
+ Collaboration diagram for FAutomationTestFramework::FAutomationTestMessageFilter:

Public Member Functions

 FAutomationTestMessageFilter ()
 
 ~FAutomationTestMessageFilter ()
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category) override
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, double Time) override
 
virtual void SerializeRecord (const UE::FLogRecord &Record) override
 
virtual bool CanBeUsedOnMultipleThreads () const override
 
void SetCurrentAutomationTest (FAutomationTestBase *InAutomationTest)
 
void SetDestinationContext (FFeedbackContext *InDestinationContext)
 
- Public Member Functions inherited from FFeedbackContext
virtual bool YesNof (const FText &Question)
 
virtual bool ReceivedUserCancel ()
 
FORCEINLINE const FSlowTaskStackGetScopeStack () const
 
void BeginSlowTask (const FText &Task, bool ShowProgressDialog, bool bShowCancelButton=false)
 
void UpdateProgress (int32 Numerator, int32 Denominator)
 
void StatusUpdate (int32 Numerator, int32 Denominator, const FText &StatusText)
 
void StatusForceUpdate (int32 Numerator, int32 Denominator, const FText &StatusText)
 
void EndSlowTask ()
 
virtual FContextSupplierGetContext () const
 
virtual void SetContext (FContextSupplier *InContext)
 
virtual TWeakPtr< class SBuildProgressWidgetShowBuildProgressWindow ()
 
virtual void CloseBuildProgressWindow ()
 
 FFeedbackContext ()
 
virtual ~FFeedbackContext ()
 
void GetWarnings (TArray< FString > &OutWarnings) const
 
int32 GetNumWarnings () const
 
void GetErrors (TArray< FString > &OutErrors) const
 
int32 GetNumErrors () const
 
void GetErrorsAndWarningsAndEmpty (TArray< FString > &OutWarningsAndErrors)
 
void ClearWarningsAndErrors ()
 
- Public Member Functions inherited from FOutputDevice
 FOutputDevice ()
 
 FOutputDevice (FOutputDevice &&)=default
 
 FOutputDevice (const FOutputDevice &)=default
 
FOutputDeviceoperator= (FOutputDevice &&)=default
 
FOutputDeviceoperator= (const FOutputDevice &)=default
 
virtual ~FOutputDevice ()=default
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
FORCEINLINE bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
FORCEINLINE bool GetAutoEmitLineTerminator () const
 
virtual void Dump (class FArchive &Ar)
 
virtual bool IsMemoryOnly () const
 
virtual bool CanBeUsedOnAnyThread () const
 
virtual bool CanBeUsedOnPanicThread () const
 
void Log (const TCHAR *S)
 
void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
void Log (const FString &S)
 
void Log (const FText &S)
 
void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE void CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 

Private Attributes

std::atomic< FAutomationTestBase * > CurTest
 
std::atomic< FFeedbackContext * > DestinationContext
 
FCriticalSection ActionCS
 

Additional Inherited Members

- Public Attributes inherited from FFeedbackContext
bool TreatWarningsAsErrors = false
 
- Protected Member Functions inherited from FFeedbackContext
virtual void StartSlowTask (const FText &Task, bool bShowCancelButton=false)
 
virtual void FinalizeSlowTask ()
 
virtual void ProgressReported (const float TotalProgressInterp, FText DisplayMessage)
 
virtual bool IsPlayingInEditor () const
 
void FormatLine (FStringBuilderBase &Out, const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, double Time, ELogVerbosity::Type *OutVerbosity=nullptr) const
 
void FormatRecordLine (FStringBuilderBase &Out, const UE::FLogRecord &Record, ELogVerbosity::Type *OutVerbosity=nullptr) const
 
const TSharedPtr< FSlowTaskStack > & GetScopeStackSharedPtr () const
 
void RequestUpdateUI (bool bForceUpdate=false)
 
void UpdateUI ()
 
void AddWarning (const FString &InWarning)
 
void AddWarning (FString &&InWarning)
 
void AddError (const FString &InError)
 
void AddError (FString &&InError)
 
- Protected Attributes inherited from FFeedbackContext
friend FSlowTask
 
FSlowTaskStack ScopeStack
 
TSharedPtr< FSlowTaskStackScopeStackSharedPtr
 
TArray< TUniquePtr< FSlowTask > > LegacyAPIScopes
 
- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Detailed Description

Special feedback context used during automated testing to filter messages that happen during tests

Definition at line 1087 of file AutomationTest.h.

Constructor & Destructor Documentation

◆ FAutomationTestMessageFilter()

FAutomationTestFramework::FAutomationTestMessageFilter::FAutomationTestMessageFilter ( )
inline

Definition at line 1090 of file AutomationTest.h.

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

◆ ~FAutomationTestMessageFilter()

FAutomationTestFramework::FAutomationTestMessageFilter::~FAutomationTestMessageFilter ( )
inline

Definition at line 1094 of file AutomationTest.h.

Member Function Documentation

◆ CanBeUsedOnMultipleThreads()

virtual bool FAutomationTestFramework::FAutomationTestMessageFilter::CanBeUsedOnMultipleThreads ( ) const
inlineoverridevirtual

FOutputDevice interface

Make it unbuffered by returning true

Reimplemented from FOutputDevice.

Definition at line 1116 of file AutomationTest.h.

◆ Serialize() [1/2]

virtual void FAutomationTestFramework::FAutomationTestMessageFilter::Serialize ( const TCHAR * V,
ELogVerbosity::Type Verbosity,
const FName & Category )
overridevirtual

FOutputDevice interface

Parameters
VString to serialize within the context
EventEvent associated with the string

Reimplemented from FFeedbackContext.

◆ Serialize() [2/2]

virtual void FAutomationTestFramework::FAutomationTestMessageFilter::Serialize ( const TCHAR * V,
ELogVerbosity::Type Verbosity,
const FName & Category,
double Time )
overridevirtual

Reimplemented from FFeedbackContext.

◆ SerializeRecord()

virtual void FAutomationTestFramework::FAutomationTestMessageFilter::SerializeRecord ( const UE::FLogRecord & Record)
overridevirtual

Reimplemented from FFeedbackContext.

◆ SetCurrentAutomationTest()

void FAutomationTestFramework::FAutomationTestMessageFilter::SetCurrentAutomationTest ( FAutomationTestBase * InAutomationTest)
inline

Set the automation test associated with the feedback context. The automation test is what will be used to determine if a given warning or error is expected and thus should not be treated as a warning or error by the destination context.

Parameters
InAutomationTestAutomation test to associate with the feedback context.

Definition at line 1128 of file AutomationTest.h.

◆ SetDestinationContext()

void FAutomationTestFramework::FAutomationTestMessageFilter::SetDestinationContext ( FFeedbackContext * InDestinationContext)
inline

Set the destination associated with the feedback context. The automation test is where all warnings, errors, etc. will be routed to.

Parameters
InAutomationTestAutomation test to associate with the feedback context.

Definition at line 1139 of file AutomationTest.h.

Member Data Documentation

◆ ActionCS

FCriticalSection FAutomationTestFramework::FAutomationTestMessageFilter::ActionCS
private

Definition at line 1147 of file AutomationTest.h.

◆ CurTest

std::atomic<FAutomationTestBase*> FAutomationTestFramework::FAutomationTestMessageFilter::CurTest
private

Definition at line 1145 of file AutomationTest.h.

◆ DestinationContext

std::atomic<FFeedbackContext*> FAutomationTestFramework::FAutomationTestMessageFilter::DestinationContext
private

Definition at line 1146 of file AutomationTest.h.


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