FAutomationTestInfo Class Reference

#include <AutomationTest.h>

Public Member Functions
	FAutomationTestInfo ()=default
	FAutomationTestInfo (const FString &InDisplayName, const FString &InFullTestPath, const FString &InTestName, const EAutomationTestFlags InTestFlags, const int32 InNumParticipantsRequired, const FString &InParameterName=FString(), const FString &InSourceFile=FString(), int32 InSourceFileLine=0, const FString &InAssetPath=FString(), const FString &InOpenCommand=FString(), const FString &InTestTags=FString())
void	AddTestFlags (const EAutomationTestFlags InTestFlags)
const FString &	GetDisplayName () const
const FString &	GetFullTestPath () const
FString	GetTestName () const
FString	GetTestTags () const
const FString	GetTestParameter () const
const FString	GetSourceFile () const
const int32	GetSourceFileLine () const
const FString	GetAssetPath () const
const FString	GetOpenCommand () const
const EAutomationTestFlags	GetTestFlags () const
void	ResetNumDevicesRunningTest ()
void	InformOfNewDeviceRunningTest ()
const int	GetNumDevicesRunningTest () const
const int32	GetNumParticipantsRequired () const
void	SetDisplayName (const FString &InDisplayName)
void	SetNumParticipantsRequired (int32 NumRequired)

Detailed Description

Simple class to store the automation test info

Constructor & Destructor Documentation

FAutomationTestInfo() [1/2]

FAutomationTestInfo::FAutomationTestInfo ( )

default

FAutomationTestInfo() [2/2]

FAutomationTestInfo::FAutomationTestInfo ( const FString &  InDisplayName, const FString &  InFullTestPath, const FString &  InTestName, const EAutomationTestFlags  InTestFlags, const int32  InNumParticipantsRequired, const FString &  InParameterName = FString(), const FString &  InSourceFile = FString(), int32  InSourceFileLine = 0, const FString &  InAssetPath = FString(), const FString &  InOpenCommand = FString(), const FString &  InTestTags = FString()  )

inline

Constructor

Parameters

InDisplayName	- Name used in the UI
InFullTestPath	- Dot-separated pathname to hierarchically display in the UI, which should be unique
InTestName	- The test command string
InTestFlags	- Test flags
InNumParticipantsRequired	- Number of workers to run test
InParameterName	- optional parameter. e.g. asset name
InSourceFile	- Filesystem path to the source file which defines the test
InSourceFileLine	- Line number in the source file which defines the test
InAssetPath	- Filesystem path to the UAsset file which defines the test
InOpenCommand	- An exec command to open the test
InTestTags	- Tag metadata concatenated into one string

Member Function Documentation

AddTestFlags()

void FAutomationTestInfo::AddTestFlags ( const EAutomationTestFlags  InTestFlags )

inline

Add a test flag if a parent node.

@Param InTestFlags - the child test flag to add.

GetAssetPath()

const FString FAutomationTestInfo::GetAssetPath ( ) const

inline

Gets the asset potentially associated with the test.

Returns

the source line number.

GetDisplayName()

const FString & FAutomationTestInfo::GetDisplayName ( ) const

inline

Get the display name of this test.

Returns

the display name.

GetFullTestPath()

const FString & FAutomationTestInfo::GetFullTestPath ( ) const

inline

Gets the full path for this test if you wanted to run it.

Returns

the display name.

GetNumDevicesRunningTest()

const int FAutomationTestInfo::GetNumDevicesRunningTest ( ) const

inline

Get the number of devices running this test

Returns

The number of devices which have been given this test to run

GetNumParticipantsRequired()

const int32 FAutomationTestInfo::GetNumParticipantsRequired ( ) const

inline

Get the number of participant this test needs in order to be run

Returns

The number of participants needed

GetOpenCommand()

const FString FAutomationTestInfo::GetOpenCommand ( ) const

inline

Gets the open command potentially associated with the test.

Returns

the source line number.

GetSourceFile()

const FString FAutomationTestInfo::GetSourceFile ( ) const

inline

Get the source file this test originated in.

Returns

the source file.

GetSourceFileLine()

const int32 FAutomationTestInfo::GetSourceFileLine ( ) const

inline

Get the line number in the source file this test originated on.

Returns

the source line number.

GetTestFlags()

const EAutomationTestFlags FAutomationTestInfo::GetTestFlags ( ) const

inline

Get the type of test.

Returns

the test type.

GetTestName()

FString FAutomationTestInfo::GetTestName ( ) const

inline

Get the test name of this test.

Returns

The test name.

GetTestParameter()

const FString FAutomationTestInfo::GetTestParameter ( ) const

inline

Get the type of parameter. This will be the asset name for linked assets.

Returns

the parameter.

GetTestTags()

FString FAutomationTestInfo::GetTestTags ( ) const

inline

Get the tags associated with this test.

Returns

The concatenated test tags.

InformOfNewDeviceRunningTest()

void FAutomationTestInfo::InformOfNewDeviceRunningTest ( )

inline

Be notified of a new device running the test so we should update our flag counting these

ResetNumDevicesRunningTest()

void FAutomationTestInfo::ResetNumDevicesRunningTest ( )

inline

Zero the number of devices running this test

SetDisplayName()

void FAutomationTestInfo::SetDisplayName ( const FString &  InDisplayName )

inline

Set the display name of the child node.

@Param InDisplayName - the new child test name.

SetNumParticipantsRequired()

void FAutomationTestInfo::SetNumParticipantsRequired ( int32  NumRequired )

inline

Set the number of participant this test needs in order to be run

@Param NumRequired - The new number of participants needed

---

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

• Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h