Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
FAutomationTestFramework::FAutomationTestOutputDevice Class Reference
+ Inheritance diagram for FAutomationTestFramework::FAutomationTestOutputDevice:
+ Collaboration diagram for FAutomationTestFramework::FAutomationTestOutputDevice:

Public Member Functions

 FAutomationTestOutputDevice ()
 
 ~FAutomationTestOutputDevice ()
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const class FName &Category) override
 
virtual bool CanBeUsedOnMultipleThreads () const override
 
void SetCurrentAutomationTest (FAutomationTestBase *InAutomationTest)
 
- Public Member Functions inherited from FOutputDevice
 FOutputDevice ()
 
 FOutputDevice (FOutputDevice &&)=default
 
 FOutputDevice (const FOutputDevice &)=default
 
FOutputDevice & operator= (FOutputDevice &&)=default
 
FOutputDevice & operator= (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 SerializeRecord (const UE::FLogRecord &Record)
 
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
 
FCriticalSection ActionCS
 
TSet< FAutomationTestBase * > LoggedFailureCause
 

Additional Inherited Members

- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Detailed Description

Special output device used during automation testing to gather messages that happen during tests

Definition at line 1035 of file AutomationTest.h.

Constructor & Destructor Documentation

◆ FAutomationTestOutputDevice()

FAutomationTestFramework::FAutomationTestOutputDevice::FAutomationTestOutputDevice ( )
inline

Definition at line 1038 of file AutomationTest.h.

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

◆ ~FAutomationTestOutputDevice()

FAutomationTestFramework::FAutomationTestOutputDevice::~FAutomationTestOutputDevice ( )
inline

Definition at line 1041 of file AutomationTest.h.

Member Function Documentation

◆ CanBeUsedOnMultipleThreads()

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

FOutputDevice interface

Make it unbuffered by returning true

Reimplemented from FOutputDevice.

Definition at line 1059 of file AutomationTest.h.

◆ Serialize()

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

FOutputDevice interface

Parameters
VString to serialize within the output device
EventEvent associated with the string

◆ SetCurrentAutomationTest()

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

Set the automation test associated with the output device. The automation test is where all warnings, errors, etc. will be routed to.

Parameters
InAutomationTestAutomation test to associate with the output device.

Definition at line 1070 of file AutomationTest.h.

Member Data Documentation

◆ ActionCS

FCriticalSection FAutomationTestFramework::FAutomationTestOutputDevice::ActionCS
private

Critical section

Definition at line 1080 of file AutomationTest.h.

◆ CurTest

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

Associated automation test; all warnings, errors, etc. are routed to the automation test to track

Definition at line 1077 of file AutomationTest.h.

◆ LoggedFailureCause

TSet<FAutomationTestBase*> FAutomationTestFramework::FAutomationTestOutputDevice::LoggedFailureCause
private

Tests that we've logged the failure cause when an error is involved

Definition at line 1083 of file AutomationTest.h.

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